Rest api » History » Version 48

Dorin Huzum, 2011-10-04 23:09

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 1 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.
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 24 Jean-Philippe Lang
|[[Rest_Issues|Issues]]         | Beta        | Usable with some bugs and rough edges.  | 1.0 |
11 24 Jean-Philippe Lang
|[[Rest_Projects|Projects]]     | Beta        | Usable with some bugs and rough edges.  | 1.0 |
12 28 Jean-Philippe Lang
|[[Rest_Users|Users]]           | Beta | | 1.1 |
13 39 Jean-Philippe Lang
|[[Rest_TimeEntries|Time Entries]]           | Beta | | 1.1 |
14 28 Jean-Philippe Lang
|[[Rest_News|News]]             | Prototype | Prototype implementation for @index@ only | 1.1 |
15 43 Jean-Philippe Lang
|[[Rest_IssueRelations|Issue Relations]]  | Alpha | | 1.3 |
16 43 Jean-Philippe Lang
|[[Rest_Versions|Versions]]  | Alpha | | 1.3 |
17 44 Jean-Philippe Lang
|[[Rest_Queries|Queries]]  | Alpha | | 1.3 |
18 45 Jean-Philippe Lang
|[[Rest_Attachments|Attachments]]  | Alpha | | 1.3 |
19 24 Jean-Philippe Lang
20 15 Eric Davis
Status legend:
21 1 Jean-Philippe Lang
22 1 Jean-Philippe Lang
* Stable - feature complete, no major changes planned
23 1 Jean-Philippe Lang
* Beta - usable for integrations with some bugs or missing minor functionality
24 1 Jean-Philippe Lang
* Alpha - major functionality in place, needs feedback from API users and integrators
25 1 Jean-Philippe Lang
* Prototype - very rough implementation, possible major breaking changes mid-version. *Not recommended for integration*
26 1 Jean-Philippe Lang
* Planned - planned in a future version, depending on developer availability
27 1 Jean-Philippe Lang
28 24 Jean-Philippe Lang
h2. General topics
29 1 Jean-Philippe Lang
30 24 Jean-Philippe Lang
h3. Authentication
31 24 Jean-Philippe Lang
32 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:
33 24 Jean-Philippe Lang
* using your regular login/password via HTTP Basic authentication.
34 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:
35 38 Jean-Philippe Lang
** passed in as a "key" parameter
36 38 Jean-Philippe Lang
** passed in as a username with a random password via HTTP Basic authentication
37 46 John Galambos
** passed in as a "X-Redmine-API-Key" HTTP header (added in Redmine 1.1.0)
38 38 Jean-Philippe Lang
39 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.
40 24 Jean-Philippe Lang
41 24 Jean-Philippe Lang
h3. Collection resources and pagination
42 24 Jean-Philippe Lang
43 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:
44 24 Jean-Philippe Lang
45 24 Jean-Philippe Lang
* @offset@: the offset of the first object to retrieve
46 24 Jean-Philippe Lang
* @limit@: the number of items to be present in the response (default is 25, maximum is 100)
47 24 Jean-Philippe Lang
48 25 Jean-Philippe Lang
Alternatively, you can use the @page@ parameter, instead of @offset@, in conjunction with @limit@.
49 24 Jean-Philippe Lang
50 24 Jean-Philippe Lang
Examples:
51 24 Jean-Philippe Lang
52 24 Jean-Philippe Lang
<pre>
53 24 Jean-Philippe Lang
GET /issues.xml
54 24 Jean-Philippe Lang
=> returns the 25 first issues
55 24 Jean-Philippe Lang
56 24 Jean-Philippe Lang
GET /issues.xml?limit=100
57 24 Jean-Philippe Lang
=> returns the 100 first issues
58 24 Jean-Philippe Lang
59 24 Jean-Philippe Lang
GET /issues.xml?offset=30&limit=10
60 24 Jean-Philippe Lang
=> returns 10 issues from the 30th
61 24 Jean-Philippe Lang
62 24 Jean-Philippe Lang
GET /issues.xml?page=3&limit=10
63 24 Jean-Philippe Lang
=> same as above
64 24 Jean-Philippe Lang
</pre>
65 24 Jean-Philippe Lang
66 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:
67 24 Jean-Philippe Lang
68 24 Jean-Philippe Lang
<pre>
69 24 Jean-Philippe Lang
GET /issues.xml
70 24 Jean-Philippe Lang
71 24 Jean-Philippe Lang
<issues type="array" total_count="2595" limit="25" offset="0">
72 24 Jean-Philippe Lang
  ...
73 24 Jean-Philippe Lang
</issues>
74 24 Jean-Philippe Lang
</pre>
75 24 Jean-Philippe Lang
76 24 Jean-Philippe Lang
<pre>
77 24 Jean-Philippe Lang
GET /issues.json
78 24 Jean-Philippe Lang
79 24 Jean-Philippe Lang
{ "issues":[...], "total_count":2595, "limit":25, "offset":0 }
80 24 Jean-Philippe Lang
</pre>
81 24 Jean-Philippe Lang
82 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:
83 24 Jean-Philippe Lang
84 24 Jean-Philippe Lang
<pre>
85 24 Jean-Philippe Lang
GET /issues.xml?nometa=1
86 24 Jean-Philippe Lang
87 24 Jean-Philippe Lang
<issues type="array">
88 24 Jean-Philippe Lang
  ...
89 24 Jean-Philippe Lang
</issues>
90 24 Jean-Philippe Lang
</pre>
91 23 Jean-Philippe Lang
92 29 Etienne Massip
h3. Fetching associated data
93 29 Etienne Massip
94 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 :
95 29 Etienne Massip
96 29 Etienne Massip
Example:
97 29 Etienne Massip
98 41 Jean-Philippe Lang
To retrieve issue journals with its description:
99 29 Etienne Massip
100 29 Etienne Massip
<pre>
101 29 Etienne Massip
GET /issues/296.xml?include=journals
102 29 Etienne Massip
103 29 Etienne Massip
<issue>
104 29 Etienne Massip
  <id>296</id>
105 30 Etienne Massip
  ...
106 29 Etienne Massip
  <journals type="array">
107 29 Etienne Massip
  ...
108 1 Jean-Philippe Lang
  </journals>
109 41 Jean-Philippe Lang
</issue>
110 41 Jean-Philippe Lang
</pre>
111 41 Jean-Philippe Lang
112 41 Jean-Philippe Lang
You can also load multiple associations using a coma separated list of items.
113 41 Jean-Philippe Lang
114 41 Jean-Philippe Lang
Example:
115 41 Jean-Philippe Lang
116 41 Jean-Philippe Lang
<pre>
117 41 Jean-Philippe Lang
GET /issues/296.xml?include=journals,changesets
118 41 Jean-Philippe Lang
119 41 Jean-Philippe Lang
<issue>
120 41 Jean-Philippe Lang
  <id>296</id>
121 41 Jean-Philippe Lang
  ...
122 41 Jean-Philippe Lang
  <journals type="array">
123 41 Jean-Philippe Lang
  ...
124 41 Jean-Philippe Lang
  </journals>
125 41 Jean-Philippe Lang
  <changesets type="array">
126 41 Jean-Philippe Lang
  ...
127 41 Jean-Philippe Lang
  </changesets>
128 29 Etienne Massip
</issue>
129 29 Etienne Massip
</pre>
130 29 Etienne Massip
131 42 Jean-Philippe Lang
h3. Working with custom fields
132 42 Jean-Philippe Lang
133 42 Jean-Philippe Lang
Most of the Redmine objects support custom fields. Their values can be found in the @custom_fields@ attributes.
134 42 Jean-Philippe Lang
135 42 Jean-Philippe Lang
XML Example:
136 42 Jean-Philippe Lang
137 42 Jean-Philippe Lang
<pre>
138 42 Jean-Philippe Lang
GET /issues/296.xml      # an issue with 2 custom fields
139 42 Jean-Philippe Lang
140 42 Jean-Philippe Lang
<issue>
141 42 Jean-Philippe Lang
  <id>296</id>
142 42 Jean-Philippe Lang
  ...
143 42 Jean-Philippe Lang
  <custom_fields type="array">
144 42 Jean-Philippe Lang
    <custom_field name="Affected version" id="1">
145 42 Jean-Philippe Lang
      <value>1.0.1</value>
146 42 Jean-Philippe Lang
    </custom_field>
147 42 Jean-Philippe Lang
    <custom_field name="Resolution" id="2">
148 42 Jean-Philippe Lang
      <value>Fixed</value>
149 42 Jean-Philippe Lang
    </custom_field>
150 42 Jean-Philippe Lang
  </custom_fields>
151 42 Jean-Philippe Lang
</issue>
152 42 Jean-Philippe Lang
</pre>
153 42 Jean-Philippe Lang
154 42 Jean-Philippe Lang
JSON Example:
155 42 Jean-Philippe Lang
156 42 Jean-Philippe Lang
<pre>
157 42 Jean-Philippe Lang
GET /issues/296.json      # an issue with 2 custom fields
158 42 Jean-Philippe Lang
159 42 Jean-Philippe Lang
{"issue":
160 42 Jean-Philippe Lang
  {
161 42 Jean-Philippe Lang
    "id":8471,
162 42 Jean-Philippe Lang
    ...
163 42 Jean-Philippe Lang
    "custom_fields":
164 42 Jean-Philippe Lang
      [
165 42 Jean-Philippe Lang
        {"value":"1.0.1","name":"Affected version","id":1},
166 42 Jean-Philippe Lang
        {"value":"Fixed","name":"Resolution","id":2}
167 42 Jean-Philippe Lang
      ]
168 42 Jean-Philippe Lang
  }
169 42 Jean-Philippe Lang
}
170 42 Jean-Philippe Lang
</pre>
171 42 Jean-Philippe Lang
172 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).
173 42 Jean-Philippe Lang
174 42 Jean-Philippe Lang
XML Example:
175 42 Jean-Philippe Lang
176 42 Jean-Philippe Lang
<pre>
177 42 Jean-Philippe Lang
PUT /issues/296.xml
178 42 Jean-Philippe Lang
179 42 Jean-Philippe Lang
<issue>
180 42 Jean-Philippe Lang
  <subject>Updating custom fields of an issue</subject>
181 42 Jean-Philippe Lang
  ...
182 42 Jean-Philippe Lang
  <custom_fields type="array">
183 42 Jean-Philippe Lang
    <custom_field id="1">
184 42 Jean-Philippe Lang
      <value>1.0.2</value>
185 42 Jean-Philippe Lang
    </custom_field>
186 42 Jean-Philippe Lang
    <custom_field id="2">
187 42 Jean-Philippe Lang
      <value>Invalid</value>
188 42 Jean-Philippe Lang
    </custom_field>
189 42 Jean-Philippe Lang
  </custom_fields>
190 42 Jean-Philippe Lang
</issue>
191 42 Jean-Philippe Lang
</pre>
192 42 Jean-Philippe Lang
193 42 Jean-Philippe Lang
Note: the @type="array"@ attribute on @custom_fields@ XML tag is strictly required.
194 42 Jean-Philippe Lang
195 42 Jean-Philippe Lang
JSON Example:
196 42 Jean-Philippe Lang
197 42 Jean-Philippe Lang
<pre>
198 42 Jean-Philippe Lang
PUT /issues/296.json
199 42 Jean-Philippe Lang
200 42 Jean-Philippe Lang
{"issue":
201 42 Jean-Philippe Lang
  {
202 42 Jean-Philippe Lang
    "subject":"Updating custom fields of an issue",
203 42 Jean-Philippe Lang
    ...
204 42 Jean-Philippe Lang
    "custom_fields":
205 42 Jean-Philippe Lang
      [
206 42 Jean-Philippe Lang
        {"value":"1.0.2","id":1},
207 42 Jean-Philippe Lang
        {"value":"Invalid","id":2}
208 42 Jean-Philippe Lang
      ]
209 42 Jean-Philippe Lang
  }
210 42 Jean-Philippe Lang
}
211 42 Jean-Philippe Lang
</pre>
212 42 Jean-Philippe Lang
213 1 Jean-Philippe Lang
h2. API Usage in various languages/tools
214 5 Jean-Philippe Lang
215 1 Jean-Philippe Lang
* [[Rest_api_with_ruby|Ruby]]
216 1 Jean-Philippe Lang
* [[Rest_api_with_php|PHP]]
217 23 Jean-Philippe Lang
* [[Rest_api_with_python|Python]]
218 27 Jean-Philippe Lang
* [[Rest_api_with_java|Java]]
219 1 Jean-Philippe Lang
* [[Rest_api_with_curl|cURL]]
220 37 Bevan Rudge
* "Drupal Redmine API module, 2.x branch (currently not stable)":http://drupal.org/project/redmine
221 48 Dorin Huzum
* [[Rest_api_with_csharp|.NET]]