Project

General

Profile

Rest api » History » Version 86

Etienne Massip, 2013-01-08 17:12
Added description to attachment example (#12773)

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