Rest Issues » History » Version 68

Go MAEDA, 2021-04-19 11:07
include=allowed_statuses (#24976)

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 62 Bubi =
* @include@: fetch associated data (optional, use comma to fetch multiple associations). Some possible values (for full list see below):
17 58 Go MAEDA
18 58 Go MAEDA
  * @attachments@ - Since 3.4.0
19 58 Go MAEDA
  * @relations@
20 68 Go MAEDA
  * @allowed_statuses@: new statuses allowed for the user (Since 5.0)
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 63 Go MAEDA
GET /issues.xml?issue_id=1
41 63 Go MAEDA
GET /issues.xml?issue_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 65 Stéphane Lavergne
71 65 Stéphane Lavergne
To fetch issues for which custom field 4 contains the substring "foo" :
72 65 Stéphane Lavergne
GET /issues.xml?cf_4=~foo
73 12 Robert Palmer
</pre>
74 1 Jean-Philippe Lang
75 1 Jean-Philippe Lang
+Response+:
76 1 Jean-Philippe Lang
77 59 Toshi MARUYAMA
<pre><code class="xml">
78 1 Jean-Philippe Lang
<?xml version="1.0" encoding="UTF-8"?>
79 1 Jean-Philippe Lang
<issues type="array" count="1640">
80 3 Christoph Witzany
  <issue>
81 3 Christoph Witzany
    <id>4326</id>
82 1 Jean-Philippe Lang
    <project name="Redmine" id="1"/>
83 1 Jean-Philippe Lang
    <tracker name="Feature" id="2"/>
84 1 Jean-Philippe Lang
    <status name="New" id="1"/>
85 1 Jean-Philippe Lang
    <priority name="Normal" id="4"/>
86 1 Jean-Philippe Lang
    <author name="John Smith" id="10106"/>
87 1 Jean-Philippe Lang
    <category name="Email notifications" id="9"/>
88 1 Jean-Philippe Lang
    <subject>
89 1 Jean-Philippe Lang
      Aggregate Multiple Issue Changes for Email Notifications
90 1 Jean-Philippe Lang
    </subject>
91 1 Jean-Philippe Lang
    <description>
92 1 Jean-Philippe Lang
      This is not to be confused with another useful proposed feature that
93 1 Jean-Philippe Lang
      would do digest emails for notifications.
94 1 Jean-Philippe Lang
    </description>
95 1 Jean-Philippe Lang
    <start_date>2009-12-03</start_date>
96 1 Jean-Philippe Lang
    <due_date></due_date>
97 1 Jean-Philippe Lang
    <done_ratio>0</done_ratio>
98 1 Jean-Philippe Lang
    <estimated_hours></estimated_hours>
99 1 Jean-Philippe Lang
    <custom_fields>
100 1 Jean-Philippe Lang
      <custom_field name="Resolution" id="2">Duplicate</custom_field>
101 1 Jean-Philippe Lang
      <custom_field name="Texte" id="5">Test</custom_field>
102 1 Jean-Philippe Lang
      <custom_field name="Boolean" id="6">1</custom_field>
103 1 Jean-Philippe Lang
      <custom_field name="Date" id="7">2010-01-12</custom_field>
104 1 Jean-Philippe Lang
    </custom_fields>
105 1 Jean-Philippe Lang
    <created_on>Thu Dec 03 15:02:12 +0100 2009</created_on>
106 1 Jean-Philippe Lang
    <updated_on>Sun Jan 03 12:08:41 +0100 2010</updated_on>
107 1 Jean-Philippe Lang
  </issue>
108 3 Christoph Witzany
  <issue>
109 3 Christoph Witzany
    <id>4325</id>
110 1 Jean-Philippe Lang
    ...
111 1 Jean-Philippe Lang
  </issue>
112 1 Jean-Philippe Lang
</issues>
113 59 Toshi MARUYAMA
</code></pre>
114 1 Jean-Philippe Lang
115 1 Jean-Philippe Lang
h2. Showing an issue
116 1 Jean-Philippe Lang
117 31 Ilya Kulakov
<pre>
118 43 Jean-Philippe Lang
GET /issues/[id].[format]
119 31 Ilya Kulakov
</pre>
120 31 Ilya Kulakov
121 43 Jean-Philippe Lang
+Parameters+:
122 1 Jean-Philippe Lang
123 43 Jean-Philippe Lang
* @include@: fetch associated data (optional, use comma to fetch multiple associations). Possible values:
124 1 Jean-Philippe Lang
125 43 Jean-Philippe Lang
  * @children@
126 43 Jean-Philippe Lang
  * @attachments@
127 43 Jean-Philippe Lang
  * @relations@
128 43 Jean-Philippe Lang
  * @changesets@
129 43 Jean-Philippe Lang
  * @journals@ - See [[Rest_IssueJournals|Issue journals]] for more information.
130 43 Jean-Philippe Lang
  * @watchers@ - Since 2.3.0
131 1 Jean-Philippe Lang
132 43 Jean-Philippe Lang
+Examples+:
133 43 Jean-Philippe Lang
134 43 Jean-Philippe Lang
<pre>
135 43 Jean-Philippe Lang
GET /issues/2.xml
136 43 Jean-Philippe Lang
GET /issues/2.json
137 43 Jean-Philippe Lang
138 43 Jean-Philippe Lang
GET /issues/2.xml
139 43 Jean-Philippe Lang
GET /issues/2.xml?include=attachments
140 1 Jean-Philippe Lang
GET /issues/2.xml?include=attachments,journals
141 43 Jean-Philippe Lang
</pre>
142 43 Jean-Philippe Lang
143 1 Jean-Philippe Lang
h2. Creating an issue
144 1 Jean-Philippe Lang
145 45 Jean-Philippe Lang
  POST /issues.[format]
146 1 Jean-Philippe Lang
147 45 Jean-Philippe Lang
+Parameters+:
148 1 Jean-Philippe Lang
149 45 Jean-Philippe Lang
* @issue@ - A hash of the issue attributes:
150 1 Jean-Philippe Lang
151 45 Jean-Philippe Lang
  * @project_id@
152 45 Jean-Philippe Lang
  * @tracker_id@
153 45 Jean-Philippe Lang
  * @status_id@
154 50 redmineservices .
  * @priority_id@
155 45 Jean-Philippe Lang
  * @subject@
156 45 Jean-Philippe Lang
  * @description@
157 45 Jean-Philippe Lang
  * @category_id@
158 49 Maarten Verwijs
  * @fixed_version_id@ - ID of the Target Versions (previously called 'Fixed Version' and still referred to as such in the API)
159 45 Jean-Philippe Lang
  * @assigned_to_id@ - ID of the user to assign the issue to (currently no mechanism to assign by name)
160 45 Jean-Philippe Lang
  * @parent_issue_id@ - ID of the parent issue
161 45 Jean-Philippe Lang
  * @custom_fields@ - See [[Rest_api#Working-with-custom-fields|Custom fields]]
162 45 Jean-Philippe Lang
  * @watcher_user_ids@ - Array of user ids to add as watchers (since 2.3.0)
163 53 Matt Wiseley
  * @is_private@ - Use true or false to indicate whether the issue is private or not
164 53 Matt Wiseley
  * @estimated_hours@ - Number of hours estimated for issue
165 45 Jean-Philippe Lang
166 1 Jean-Philippe Lang
Attachments can be added when you create an issue, see [[Rest_api#Attaching-files|Attaching files]].
167 1 Jean-Philippe Lang
168 45 Jean-Philippe Lang
+Examples+:
169 1 Jean-Philippe Lang
170 66 Toshi MARUYAMA
<pre>
171 1 Jean-Philippe Lang
POST /issues.xml
172 66 Toshi MARUYAMA
</pre>
173 66 Toshi MARUYAMA
<pre><code class="xml">
174 45 Jean-Philippe Lang
<?xml version="1.0"?>
175 45 Jean-Philippe Lang
<issue>
176 45 Jean-Philippe Lang
  <project_id>1</project_id>
177 1 Jean-Philippe Lang
  <subject>Example</subject>
178 1 Jean-Philippe Lang
  <priority_id>4</priority_id>
179 45 Jean-Philippe Lang
</issue>
180 59 Toshi MARUYAMA
</code></pre>
181 1 Jean-Philippe Lang
<pre>
182 1 Jean-Philippe Lang
POST /issues.json
183 59 Toshi MARUYAMA
</pre>
184 59 Toshi MARUYAMA
<pre><code class="json">
185 45 Jean-Philippe Lang
{
186 45 Jean-Philippe Lang
  "issue": {
187 45 Jean-Philippe Lang
    "project_id": 1,
188 45 Jean-Philippe Lang
    "subject": "Example",
189 45 Jean-Philippe Lang
    "priority_id": 4
190 45 Jean-Philippe Lang
  }
191 45 Jean-Philippe Lang
}
192 59 Toshi MARUYAMA
</code></pre>
193 45 Jean-Philippe Lang
194 38 Jean-Philippe Lang
h2. Updating an issue
195 5 Damien Churchill
196 45 Jean-Philippe Lang
  PUT /issues/[id].[format]
197 5 Damien Churchill
198 45 Jean-Philippe Lang
+Parameters+:
199 5 Damien Churchill
200 45 Jean-Philippe Lang
* @issue@ - A hash of the issue attributes
201 27 Stéphane Schoorens
202 45 Jean-Philippe Lang
  * @project_id@
203 45 Jean-Philippe Lang
  * @tracker_id@
204 45 Jean-Philippe Lang
  * @status_id@
205 45 Jean-Philippe Lang
  * @subject@
206 45 Jean-Philippe Lang
  * ...
207 45 Jean-Philippe Lang
  * @notes@ - Comments about the update
208 54 Matt Wiseley
  * @private_notes@ - true if notes are private
209 1 Jean-Philippe Lang
210 1 Jean-Philippe Lang
Attachments can be added when you update an issue, see [[Rest_api#Attaching-files|Attaching files]].
211 1 Jean-Philippe Lang
212 1 Jean-Philippe Lang
+Examples+:
213 1 Jean-Philippe Lang
214 45 Jean-Philippe Lang
<pre>
215 45 Jean-Philippe Lang
PUT /issues/[id].xml
216 59 Toshi MARUYAMA
</pre>
217 59 Toshi MARUYAMA
218 59 Toshi MARUYAMA
<pre>
219 59 Toshi MARUYAMA
<code class="xml">
220 45 Jean-Philippe Lang
<?xml version="1.0"?>
221 1 Jean-Philippe Lang
<issue>
222 1 Jean-Philippe Lang
  <subject>Subject changed</subject>
223 1 Jean-Philippe Lang
  <notes>The subject was changed</notes>
224 45 Jean-Philippe Lang
</issue>
225 59 Toshi MARUYAMA
</code></pre>
226 45 Jean-Philippe Lang
227 45 Jean-Philippe Lang
<pre>
228 45 Jean-Philippe Lang
PUT /issues/[id].json
229 59 Toshi MARUYAMA
</pre>
230 59 Toshi MARUYAMA
231 59 Toshi MARUYAMA
<pre><code class="json">
232 45 Jean-Philippe Lang
{
233 45 Jean-Philippe Lang
  "issue": {
234 45 Jean-Philippe Lang
    "subject": "Subject changed",
235 45 Jean-Philippe Lang
    "notes": "The subject was changed"
236 45 Jean-Philippe Lang
  }
237 1 Jean-Philippe Lang
}
238 45 Jean-Philippe Lang
</pre>
239 44 Jean-Philippe Lang
240 44 Jean-Philippe Lang
h2. Deleting an issue
241 44 Jean-Philippe Lang
242 45 Jean-Philippe Lang
  DELETE /issues/[id].[format]
243 44 Jean-Philippe Lang
244 46 Jean-Philippe Lang
h2. Adding a watcher 
245 1 Jean-Philippe Lang
246 46 Jean-Philippe Lang
_Added in 2.3.0_
247 46 Jean-Philippe Lang
248 44 Jean-Philippe Lang
  POST /issues/[id]/watchers.[format]
249 44 Jean-Philippe Lang
250 44 Jean-Philippe Lang
+Parameters+:
251 44 Jean-Philippe Lang
252 44 Jean-Philippe Lang
* @user_id@ (required): id of the user to add as a watcher
253 44 Jean-Philippe Lang
254 1 Jean-Philippe Lang
h2. Removing a watcher
255 46 Jean-Philippe Lang
256 46 Jean-Philippe Lang
_Added in 2.3.0_
257 1 Jean-Philippe Lang
258 1 Jean-Philippe Lang
  DELETE /issues/[id]/watchers/[user_id].[format]
259 1 Jean-Philippe Lang
260 1 Jean-Philippe Lang
+Parameters+: _none_