Rest Issues » History » Version 61

Bubi =, 2018-08-01 07:35
Updated include possible values list

1 1 Jean-Philippe Lang
h1. Issues
2 1 Jean-Philippe Lang
3 28 Jean-Philippe Lang
{{>toc}}
4 28 Jean-Philippe Lang
5 1 Jean-Philippe Lang
h2. Listing issues
6 1 Jean-Philippe Lang
7 45 Jean-Philippe Lang
  GET /issues.[format]
8 1 Jean-Philippe Lang
9 2 Jean-Philippe Lang
Returns a paginated list of issues. By default, it returns open issues only.
10 1 Jean-Philippe Lang
11 1 Jean-Philippe Lang
+Parameters+:
12 26 Etienne Massip
13 21 Alex Last
* @offset@: skip this number of issues in response (optional)
14 21 Alex Last
* @limit@: number of issues per page (optional)
15 36 Emmanuel Bourgerie
* @sort@: column to sort with. Append @:desc@ to invert the order.
16 58 Go MAEDA
* @include@: fetch associated data (optional, use comma to fetch multiple associations). Possible values:
17 58 Go MAEDA
18 58 Go MAEDA
  * @attachments@ - Since 3.4.0
19 58 Go MAEDA
  * @relations@
20 61 Bubi =
  * @journals@
21 23 Alex Last
22 2 Jean-Philippe Lang
Optional filters:
23 2 Jean-Philippe Lang
24 56 Rafael Dantas
* @issue_id@: get issue with the given id or multiple issues by id using ',' to separate id.
25 55 Go MAEDA
* @project_id@: get issues from the project with the given id (a numeric value, not a project identifier).
26 40 Matthias Lamoureux
* @subproject_id@: get issues from the subproject with the given id. You can use @project_id=XXX&subproject_id=!*@ to get only the issues of a given project and none of its subprojects.
27 2 Jean-Philippe Lang
* @tracker_id@: get issues from the tracker with the given id
28 33 Ilya Kulakov
* @status_id@: get issues with the given status id only. Possible values: @open@, @closed@, @*@ to get open and closed issues, status id
29 52 davi vidal
* @assigned_to_id@: get issues which are assigned to the given user id. @me@ can be used instead an ID to fetch all issues from the logged in user (via API key or HTTP auth)
30 57 Go MAEDA
* @parent_id@: get issues whose parent issue is given id.
31 25 John Manktelow
* @cf_x@: get issues with the given value for custom field with an ID of @x@. (Custom field must have 'used as a filter' checked.)
32 2 Jean-Philippe Lang
* ...
33 2 Jean-Philippe Lang
34 47 Jean-Baptiste Barth
NB: operators containing ">", "<" or "=" should be hex-encoded so they're parsed correctly. Most evolved API clients will do that for you by default, but for the sake of clarity the following examples have been written with no such magic feature in mind.
35 47 Jean-Baptiste Barth
36 2 Jean-Philippe Lang
+Examples+:
37 2 Jean-Philippe Lang
38 2 Jean-Philippe Lang
<pre>
39 2 Jean-Philippe Lang
GET /issues.xml
40 60 Matteo Steccolini
GET /issues.xml?id=1
41 60 Matteo Steccolini
GET /issues.xml?id=1,2
42 2 Jean-Philippe Lang
GET /issues.xml?project_id=2
43 1 Jean-Philippe Lang
GET /issues.xml?project_id=2&tracker_id=1
44 1 Jean-Philippe Lang
GET /issues.xml?assigned_to_id=6
45 52 davi vidal
GET /issues.xml?assigned_to_id=me
46 12 Robert Palmer
GET /issues.xml?status_id=closed
47 1 Jean-Philippe Lang
GET /issues.xml?status_id=*
48 25 John Manktelow
GET /issues.xml?cf_1=abcdef
49 48 Filou Centrinov
GET /issues.xml?sort=category:desc,updated_on
50 56 Rafael Dantas
51 21 Alex Last
52 21 Alex Last
Paging example:
53 45 Jean-Philippe Lang
GET /issues.xml?offset=0&limit=100
54 1 Jean-Philippe Lang
GET /issues.xml?offset=100&limit=100
55 1 Jean-Philippe Lang
56 47 Jean-Baptiste Barth
To fetch issues for a date range (uncrypted filter is "><2012-03-01|2012-03-07") :
57 47 Jean-Baptiste Barth
GET /issues.xml?created_on=%3E%3C2012-03-01|2012-03-07
58 47 Jean-Baptiste Barth
59 47 Jean-Baptiste Barth
To fetch issues created after a certain date (uncrypted filter is ">=2012-03-01") :
60 47 Jean-Baptiste Barth
GET /issues.xml?created_on=%3E%3D2012-03-01
61 47 Jean-Baptiste Barth
62 47 Jean-Baptiste Barth
Or before a certain date (uncrypted filter is "<= 2012-03-07") :
63 47 Jean-Baptiste Barth
GET /issues.xml?created_on=%3C%3D2012-03-07
64 51 Jean-Philippe Lang
65 51 Jean-Philippe Lang
To fetch issues created after a certain timestamp (uncrypted filter is ">=2014-01-02T08:12:32Z") :
66 51 Jean-Philippe Lang
GET /issues.xml?created_on=%3E%3D2014-01-02T08:12:32Z
67 51 Jean-Philippe Lang
68 51 Jean-Philippe Lang
To fetch issues updated after a certain timestamp (uncrypted filter is ">=2014-01-02T08:12:32Z") :
69 51 Jean-Philippe Lang
GET /issues.xml?updated_on=%3E%3D2014-01-02T08:12:32Z
70 12 Robert Palmer
</pre>
71 1 Jean-Philippe Lang
72 1 Jean-Philippe Lang
+Response+:
73 1 Jean-Philippe Lang
74 59 Toshi MARUYAMA
<pre><code class="xml">
75 1 Jean-Philippe Lang
<?xml version="1.0" encoding="UTF-8"?>
76 1 Jean-Philippe Lang
<issues type="array" count="1640">
77 3 Christoph Witzany
  <issue>
78 3 Christoph Witzany
    <id>4326</id>
79 1 Jean-Philippe Lang
    <project name="Redmine" id="1"/>
80 1 Jean-Philippe Lang
    <tracker name="Feature" id="2"/>
81 1 Jean-Philippe Lang
    <status name="New" id="1"/>
82 1 Jean-Philippe Lang
    <priority name="Normal" id="4"/>
83 1 Jean-Philippe Lang
    <author name="John Smith" id="10106"/>
84 1 Jean-Philippe Lang
    <category name="Email notifications" id="9"/>
85 1 Jean-Philippe Lang
    <subject>
86 1 Jean-Philippe Lang
      Aggregate Multiple Issue Changes for Email Notifications
87 1 Jean-Philippe Lang
    </subject>
88 1 Jean-Philippe Lang
    <description>
89 1 Jean-Philippe Lang
      This is not to be confused with another useful proposed feature that
90 1 Jean-Philippe Lang
      would do digest emails for notifications.
91 1 Jean-Philippe Lang
    </description>
92 1 Jean-Philippe Lang
    <start_date>2009-12-03</start_date>
93 1 Jean-Philippe Lang
    <due_date></due_date>
94 1 Jean-Philippe Lang
    <done_ratio>0</done_ratio>
95 1 Jean-Philippe Lang
    <estimated_hours></estimated_hours>
96 1 Jean-Philippe Lang
    <custom_fields>
97 1 Jean-Philippe Lang
      <custom_field name="Resolution" id="2">Duplicate</custom_field>
98 1 Jean-Philippe Lang
      <custom_field name="Texte" id="5">Test</custom_field>
99 1 Jean-Philippe Lang
      <custom_field name="Boolean" id="6">1</custom_field>
100 1 Jean-Philippe Lang
      <custom_field name="Date" id="7">2010-01-12</custom_field>
101 1 Jean-Philippe Lang
    </custom_fields>
102 1 Jean-Philippe Lang
    <created_on>Thu Dec 03 15:02:12 +0100 2009</created_on>
103 1 Jean-Philippe Lang
    <updated_on>Sun Jan 03 12:08:41 +0100 2010</updated_on>
104 1 Jean-Philippe Lang
  </issue>
105 3 Christoph Witzany
  <issue>
106 3 Christoph Witzany
    <id>4325</id>
107 1 Jean-Philippe Lang
    ...
108 1 Jean-Philippe Lang
  </issue>
109 1 Jean-Philippe Lang
</issues>
110 59 Toshi MARUYAMA
</code></pre>
111 1 Jean-Philippe Lang
112 1 Jean-Philippe Lang
h2. Showing an issue
113 1 Jean-Philippe Lang
114 31 Ilya Kulakov
<pre>
115 43 Jean-Philippe Lang
GET /issues/[id].[format]
116 31 Ilya Kulakov
</pre>
117 31 Ilya Kulakov
118 43 Jean-Philippe Lang
+Parameters+:
119 1 Jean-Philippe Lang
120 43 Jean-Philippe Lang
* @include@: fetch associated data (optional, use comma to fetch multiple associations). Possible values:
121 1 Jean-Philippe Lang
122 43 Jean-Philippe Lang
  * @children@
123 43 Jean-Philippe Lang
  * @attachments@
124 43 Jean-Philippe Lang
  * @relations@
125 43 Jean-Philippe Lang
  * @changesets@
126 43 Jean-Philippe Lang
  * @journals@ - See [[Rest_IssueJournals|Issue journals]] for more information.
127 43 Jean-Philippe Lang
  * @watchers@ - Since 2.3.0
128 1 Jean-Philippe Lang
129 43 Jean-Philippe Lang
+Examples+:
130 43 Jean-Philippe Lang
131 43 Jean-Philippe Lang
<pre>
132 43 Jean-Philippe Lang
GET /issues/2.xml
133 43 Jean-Philippe Lang
GET /issues/2.json
134 43 Jean-Philippe Lang
135 43 Jean-Philippe Lang
GET /issues/2.xml
136 43 Jean-Philippe Lang
GET /issues/2.xml?include=attachments
137 1 Jean-Philippe Lang
GET /issues/2.xml?include=attachments,journals
138 43 Jean-Philippe Lang
</pre>
139 43 Jean-Philippe Lang
140 1 Jean-Philippe Lang
h2. Creating an issue
141 1 Jean-Philippe Lang
142 45 Jean-Philippe Lang
  POST /issues.[format]
143 1 Jean-Philippe Lang
144 45 Jean-Philippe Lang
+Parameters+:
145 1 Jean-Philippe Lang
146 45 Jean-Philippe Lang
* @issue@ - A hash of the issue attributes:
147 1 Jean-Philippe Lang
148 45 Jean-Philippe Lang
  * @project_id@
149 45 Jean-Philippe Lang
  * @tracker_id@
150 45 Jean-Philippe Lang
  * @status_id@
151 50 redmineservices .
  * @priority_id@
152 45 Jean-Philippe Lang
  * @subject@
153 45 Jean-Philippe Lang
  * @description@
154 45 Jean-Philippe Lang
  * @category_id@
155 49 Maarten Verwijs
  * @fixed_version_id@ - ID of the Target Versions (previously called 'Fixed Version' and still referred to as such in the API)
156 45 Jean-Philippe Lang
  * @assigned_to_id@ - ID of the user to assign the issue to (currently no mechanism to assign by name)
157 45 Jean-Philippe Lang
  * @parent_issue_id@ - ID of the parent issue
158 45 Jean-Philippe Lang
  * @custom_fields@ - See [[Rest_api#Working-with-custom-fields|Custom fields]]
159 45 Jean-Philippe Lang
  * @watcher_user_ids@ - Array of user ids to add as watchers (since 2.3.0)
160 53 Matt Wiseley
  * @is_private@ - Use true or false to indicate whether the issue is private or not
161 53 Matt Wiseley
  * @estimated_hours@ - Number of hours estimated for issue
162 45 Jean-Philippe Lang
163 1 Jean-Philippe Lang
Attachments can be added when you create an issue, see [[Rest_api#Attaching-files|Attaching files]].
164 1 Jean-Philippe Lang
165 45 Jean-Philippe Lang
+Examples+:
166 1 Jean-Philippe Lang
167 59 Toshi MARUYAMA
<pre><code class="xml">
168 45 Jean-Philippe Lang
POST /issues.xml
169 45 Jean-Philippe Lang
<?xml version="1.0"?>
170 45 Jean-Philippe Lang
<issue>
171 45 Jean-Philippe Lang
  <project_id>1</project_id>
172 1 Jean-Philippe Lang
  <subject>Example</subject>
173 1 Jean-Philippe Lang
  <priority_id>4</priority_id>
174 45 Jean-Philippe Lang
</issue>
175 59 Toshi MARUYAMA
</code></pre>
176 1 Jean-Philippe Lang
<pre>
177 1 Jean-Philippe Lang
POST /issues.json
178 59 Toshi MARUYAMA
</pre>
179 59 Toshi MARUYAMA
<pre><code class="json">
180 45 Jean-Philippe Lang
{
181 45 Jean-Philippe Lang
  "issue": {
182 45 Jean-Philippe Lang
    "project_id": 1,
183 45 Jean-Philippe Lang
    "subject": "Example",
184 45 Jean-Philippe Lang
    "priority_id": 4
185 45 Jean-Philippe Lang
  }
186 45 Jean-Philippe Lang
}
187 59 Toshi MARUYAMA
</code></pre>
188 45 Jean-Philippe Lang
189 38 Jean-Philippe Lang
h2. Updating an issue
190 5 Damien Churchill
191 45 Jean-Philippe Lang
  PUT /issues/[id].[format]
192 5 Damien Churchill
193 45 Jean-Philippe Lang
+Parameters+:
194 5 Damien Churchill
195 45 Jean-Philippe Lang
* @issue@ - A hash of the issue attributes
196 27 Stéphane Schoorens
197 45 Jean-Philippe Lang
  * @project_id@
198 45 Jean-Philippe Lang
  * @tracker_id@
199 45 Jean-Philippe Lang
  * @status_id@
200 45 Jean-Philippe Lang
  * @subject@
201 45 Jean-Philippe Lang
  * ...
202 45 Jean-Philippe Lang
  * @notes@ - Comments about the update
203 54 Matt Wiseley
  * @private_notes@ - true if notes are private
204 1 Jean-Philippe Lang
205 1 Jean-Philippe Lang
Attachments can be added when you update an issue, see [[Rest_api#Attaching-files|Attaching files]].
206 1 Jean-Philippe Lang
207 1 Jean-Philippe Lang
+Examples+:
208 1 Jean-Philippe Lang
209 45 Jean-Philippe Lang
<pre>
210 45 Jean-Philippe Lang
PUT /issues/[id].xml
211 59 Toshi MARUYAMA
</pre>
212 59 Toshi MARUYAMA
213 59 Toshi MARUYAMA
<pre>
214 59 Toshi MARUYAMA
<code class="xml">
215 45 Jean-Philippe Lang
<?xml version="1.0"?>
216 1 Jean-Philippe Lang
<issue>
217 1 Jean-Philippe Lang
  <subject>Subject changed</subject>
218 1 Jean-Philippe Lang
  <notes>The subject was changed</notes>
219 45 Jean-Philippe Lang
</issue>
220 59 Toshi MARUYAMA
</code></pre>
221 45 Jean-Philippe Lang
222 45 Jean-Philippe Lang
<pre>
223 45 Jean-Philippe Lang
PUT /issues/[id].json
224 59 Toshi MARUYAMA
</pre>
225 59 Toshi MARUYAMA
226 59 Toshi MARUYAMA
<pre><code class="json">
227 45 Jean-Philippe Lang
{
228 45 Jean-Philippe Lang
  "issue": {
229 45 Jean-Philippe Lang
    "subject": "Subject changed",
230 45 Jean-Philippe Lang
    "notes": "The subject was changed"
231 45 Jean-Philippe Lang
  }
232 1 Jean-Philippe Lang
}
233 45 Jean-Philippe Lang
</pre>
234 44 Jean-Philippe Lang
235 44 Jean-Philippe Lang
h2. Deleting an issue
236 44 Jean-Philippe Lang
237 45 Jean-Philippe Lang
  DELETE /issues/[id].[format]
238 44 Jean-Philippe Lang
239 46 Jean-Philippe Lang
h2. Adding a watcher 
240 1 Jean-Philippe Lang
241 46 Jean-Philippe Lang
_Added in 2.3.0_
242 46 Jean-Philippe Lang
243 44 Jean-Philippe Lang
  POST /issues/[id]/watchers.[format]
244 44 Jean-Philippe Lang
245 44 Jean-Philippe Lang
+Parameters+:
246 44 Jean-Philippe Lang
247 44 Jean-Philippe Lang
* @user_id@ (required): id of the user to add as a watcher
248 44 Jean-Philippe Lang
249 1 Jean-Philippe Lang
h2. Removing a watcher
250 46 Jean-Philippe Lang
251 46 Jean-Philippe Lang
_Added in 2.3.0_
252 1 Jean-Philippe Lang
253 1 Jean-Philippe Lang
  DELETE /issues/[id]/watchers/[user_id].[format]
254 1 Jean-Philippe Lang
255 1 Jean-Philippe Lang
+Parameters+: _none_