Project

General

Profile

Rest Issues » History » Version 67

Go MAEDA, 2020-12-04 07:42
The 'include' parameter for 'GET /issues.[format]' does not support 'journals' and 'children'

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