Project

General

Profile

Rest api » History » Version 100

Go MAEDA, 2019-02-02 07:57
Added a filename parameter when uploading a file (#30428)

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 91 Jean-Philippe Lang
|[[Rest_Issues|Issues]]         | Stable        |  | 1.0 |
11
|[[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
|[[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 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
* Stable - feature complete, no major changes planned
34
* Beta - usable for integrations with some bugs or missing minor functionality
35
* Alpha - major functionality in place, needs feedback from API users and integrators
36
* Prototype - very rough implementation, possible major breaking changes mid-version. *Not recommended for integration*
37
* Planned - planned in a future version, depending on developer availability
38
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
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
51 99 Go MAEDA
Most of the time, the API requires authentication. To enable the API-style authentication, you have to check *Enable REST API* in Administration -> Settings -> API. 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
** passed in as a "key" parameter
55
** 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
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
62
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
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
66 24 Jean-Philippe Lang
h3. Collection resources and pagination
67
68 98 Go MAEDA
The response to a GET request on a collection resources (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 resources using the following parameters:
69 24 Jean-Philippe Lang
70
* @offset@: the offset of the first object to retrieve
71
* @limit@: the number of items to be present in the response (default is 25, maximum is 100)
72
73
Examples:
74
75
<pre>
76
GET /issues.xml
77
=> returns the 25 first issues
78
79
GET /issues.xml?limit=100
80
=> returns the 100 first issues
81
82
GET /issues.xml?offset=30&limit=10
83
=> returns 10 issues from the 30th
84
</pre>
85
86 98 Go MAEDA
Responses to GET requests on collection resources 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
<pre>
89
GET /issues.xml
90
91
<issues type="array" total_count="2595" limit="25" offset="0">
92
  ...
93
</issues>
94
</pre>
95
96
<pre>
97
GET /issues.json
98
99
{ "issues":[...], "total_count":2595, "limit":25, "offset":0 }
100
</pre>
101
102
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
104
<pre>
105
GET /issues.xml?nometa=1
106
107
<issues type="array">
108
  ...
109
</issues>
110
</pre>
111 23 Jean-Philippe Lang
112 29 Etienne Massip
h3. Fetching associated data
113
114
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
116
Example:
117
118 41 Jean-Philippe Lang
To retrieve issue journals with its description:
119 29 Etienne Massip
120
<pre>
121
GET /issues/296.xml?include=journals
122
123
<issue>
124
  <id>296</id>
125 30 Etienne Massip
  ...
126 29 Etienne Massip
  <journals type="array">
127
  ...
128 1 Jean-Philippe Lang
  </journals>
129 41 Jean-Philippe Lang
</issue>
130
</pre>
131
132 98 Go MAEDA
You can also load multiple associations using a comma separated list of items.
133 41 Jean-Philippe Lang
134
Example:
135
136
<pre>
137
GET /issues/296.xml?include=journals,changesets
138
139
<issue>
140
  <id>296</id>
141
  ...
142
  <journals type="array">
143
  ...
144
  </journals>
145
  <changesets type="array">
146
  ...
147
  </changesets>
148 29 Etienne Massip
</issue>
149
</pre>
150
151 42 Jean-Philippe Lang
h3. Working with custom fields
152
153
Most of the Redmine objects support custom fields. Their values can be found in the @custom_fields@ attributes.
154
155
XML Example:
156
157
<pre>
158
GET /issues/296.xml      # an issue with 2 custom fields
159
160
<issue>
161
  <id>296</id>
162
  ...
163
  <custom_fields type="array">
164
    <custom_field name="Affected version" id="1">
165
      <value>1.0.1</value>
166
    </custom_field>
167
    <custom_field name="Resolution" id="2">
168
      <value>Fixed</value>
169
    </custom_field>
170
  </custom_fields>
171
</issue>
172
</pre>
173
174
JSON Example:
175
176
<pre>
177
GET /issues/296.json      # an issue with 2 custom fields
178
179
{"issue":
180
  {
181
    "id":8471,
182
    ...
183
    "custom_fields":
184
      [
185
        {"value":"1.0.1","name":"Affected version","id":1},
186
        {"value":"Fixed","name":"Resolution","id":2}
187
      ]
188
  }
189
}
190
</pre>
191
192
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
194
XML Example:
195
196
<pre>
197
PUT /issues/296.xml
198
199
<issue>
200
  <subject>Updating custom fields of an issue</subject>
201
  ...
202
  <custom_fields type="array">
203
    <custom_field id="1">
204
      <value>1.0.2</value>
205
    </custom_field>
206
    <custom_field id="2">
207
      <value>Invalid</value>
208
    </custom_field>
209
  </custom_fields>
210
</issue>
211
</pre>
212
213
Note: the @type="array"@ attribute on @custom_fields@ XML tag is strictly required.
214
215
JSON Example:
216
217
<pre>
218
PUT /issues/296.json
219
220
{"issue":
221
  {
222
    "subject":"Updating custom fields of an issue",
223
    ...
224
    "custom_fields":
225
      [
226
        {"value":"1.0.2","id":1},
227
        {"value":"Invalid","id":2}
228
      ]
229
  }
230
}
231
</pre>
232
233 61 Jean-Philippe Lang
h3. Attaching files
234
235
Support for adding attachments through the REST API is added in Redmine version:1.4.0.
236
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
241
+XML Example+
242
243
First, upload your file:
244
245 61 Jean-Philippe Lang
<pre>
246 100 Go MAEDA
POST /uploads.xml?filename=image.png
247 61 Jean-Philippe Lang
Content-Type: application/octet-stream
248
...
249
(request body is the file content)
250
251
# 201 response
252
<upload>
253
  <token>7167.ed1ccdb093229ca1bd0b043618d88743</token>
254
</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
<pre>
260
POST /issues.xml
261
<issue>
262
  <project_id>1</project_id>
263
  <subject>Creating an issue with a uploaded file</subject>
264 62 Jean-Philippe Lang
  <uploads type="array">
265 61 Jean-Philippe Lang
    <upload>
266
      <token>7167.ed1ccdb093229ca1bd0b043618d88743</token>
267
      <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
    </upload>
271
  </uploads>
272
</issue>
273
</pre>
274
275 64 Jean-Philippe Lang
If you try to upload a file that exceeds the maximum size allowed, you get a 422 response:
276
277
<pre>
278 100 Go MAEDA
POST /uploads.xml?filename=image.png
279 64 Jean-Philippe Lang
Content-Type: application/octet-stream
280
...
281
(request body larger than the maximum size allowed)
282
283
# 422 response
284
<errors>
285 1 Jean-Philippe Lang
  <error>This file cannot be uploaded because it exceeds the maximum allowed file size (1024000)</error>
286
</errors>
287 93 Jean-Philippe Lang
</pre>
288
289
+JSON Example+
290
291
First, upload your file:
292
293
<pre>
294 100 Go MAEDA
POST /uploads.json?filename=image.png
295 93 Jean-Philippe Lang
Content-Type: application/octet-stream
296
...
297
(request body is the file content)
298
299
# 201 response
300
{"upload":{"token":"7167.ed1ccdb093229ca1bd0b043618d88743"}}
301
</pre>
302
303
Then create the issue using the upload token:
304
305
<pre>
306
POST /issues.json
307
{
308
  "issue": {
309
    "project_id": "1",
310
    "subject": "Creating an issue with a uploaded file",
311
    "uploads": [
312
      {"token": "7167.ed1ccdb093229ca1bd0b043618d88743", "filename": "image.png", "content_type": "image/png"}
313
    ]
314
  }
315
}
316
</pre>
317
318
You can also upload multiple files (by doing multiple POST requests to @/uploads.json@), then create an issue with multiple attachments:
319
320
<pre>
321
POST /issues.json
322
{
323
  "issue": {
324
    "project_id": "1",
325
    "subject": "Creating an issue with a uploaded file",
326
    "uploads": [
327
      {"token": "7167.ed1ccdb093229ca1bd0b043618d88743", "filename": "image1.png", "content_type": "image/png"},
328
      {"token": "7168.d595398bbb104ed3bba0eed666785cc6", "filename": "image2.png", "content_type": "image/png"}
329
    ]
330
  }
331
}
332 64 Jean-Philippe Lang
</pre>
333
334 59 Jean-Philippe Lang
h3. Validation errors
335
336
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
338
+XML Example+:
339
340
<pre>
341
# Request with invalid or missing attributes
342
POST /users.xml
343
<user>
344
  <login>john</login>
345
  <lastname>Smith</lastname>
346
  <mail>john</mail>
347
</uer>
348
349
# 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
  <error>Email is invalid</error>
353
</errors>
354
</pre>
355
356
357
+JSON Example+:
358
359
<pre>
360
# Request with invalid or missing attributes
361
POST /users.json
362
{
363
  "user":{
364
    "login":"john",
365
    "lastname":"Smith",
366
    "mail":"john"
367
  }
368
}
369
370
# 422 response with the error messages in its body
371
{
372
  "errors":[
373
    "First name can't be blank",
374
    "Email is invalid"
375
  ]
376
}
377
</pre>
378
379 81 Jean-Philippe Lang
h3. JSONP Support
380
381 99 Go MAEDA
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 -> API.
382 81 Jean-Philippe Lang
383
Example:
384
385
<pre>
386
GET /issues.json?callback=myHandler
387
388
myHandler({"issues":[ ... ]})
389
</pre>
390
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
* [[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
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
409
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
411
Example:
412
413
<pre>
414
GET /issues/296.json
415
416
{"issue":
417
  {
418
    "id":8471,
419
    ...
420
    "custom_fields":
421
      [
422
        {"value":["1.0.1","1.0.2"],"multiple":true,"name":"Affected version","id":1},
423
        {"value":"Fixed","name":"Resolution","id":2}
424
      ]
425
  }
426
}
427
</pre>