Rest api » History » Version 54

Jean-Philippe Lang, 2012-01-29 22:53
Note about multiselect custom fields in API responses

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