Project

General

Profile

Rest Issues » History » Version 63

Go MAEDA, 2018-09-09 02:20
Fixed wrong examples: s/id/issue_id/ (#29521)

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 61 Bubi =
  * @journals@
21 23 Alex Last
22 2 Jean-Philippe Lang
Optional filters:
23
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
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
36 2 Jean-Philippe Lang
+Examples+:
37
38
<pre>
39
GET /issues.xml
40 63 Go MAEDA
GET /issues.xml?issue_id=1
41
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
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
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
56 47 Jean-Baptiste Barth
To fetch issues for a date range (uncrypted filter is "><2012-03-01|2012-03-07") :
57
GET /issues.xml?created_on=%3E%3C2012-03-01|2012-03-07
58
59
To fetch issues created after a certain date (uncrypted filter is ">=2012-03-01") :
60
GET /issues.xml?created_on=%3E%3D2012-03-01
61
62
Or before a certain date (uncrypted filter is "<= 2012-03-07") :
63
GET /issues.xml?created_on=%3C%3D2012-03-07
64 51 Jean-Philippe Lang
65
To fetch issues created after a certain timestamp (uncrypted filter is ">=2014-01-02T08:12:32Z") :
66
GET /issues.xml?created_on=%3E%3D2014-01-02T08:12:32Z
67
68
To fetch issues updated after a certain timestamp (uncrypted filter is ">=2014-01-02T08:12:32Z") :
69
GET /issues.xml?updated_on=%3E%3D2014-01-02T08:12:32Z
70 12 Robert Palmer
</pre>
71 1 Jean-Philippe Lang
72
+Response+:
73
74 59 Toshi MARUYAMA
<pre><code class="xml">
75 1 Jean-Philippe Lang
<?xml version="1.0" encoding="UTF-8"?>
76
<issues type="array" count="1640">
77 3 Christoph Witzany
  <issue>
78
    <id>4326</id>
79 1 Jean-Philippe Lang
    <project name="Redmine" id="1"/>
80
    <tracker name="Feature" id="2"/>
81
    <status name="New" id="1"/>
82
    <priority name="Normal" id="4"/>
83
    <author name="John Smith" id="10106"/>
84
    <category name="Email notifications" id="9"/>
85
    <subject>
86
      Aggregate Multiple Issue Changes for Email Notifications
87
    </subject>
88
    <description>
89
      This is not to be confused with another useful proposed feature that
90
      would do digest emails for notifications.
91
    </description>
92
    <start_date>2009-12-03</start_date>
93
    <due_date></due_date>
94
    <done_ratio>0</done_ratio>
95
    <estimated_hours></estimated_hours>
96
    <custom_fields>
97
      <custom_field name="Resolution" id="2">Duplicate</custom_field>
98
      <custom_field name="Texte" id="5">Test</custom_field>
99
      <custom_field name="Boolean" id="6">1</custom_field>
100
      <custom_field name="Date" id="7">2010-01-12</custom_field>
101
    </custom_fields>
102
    <created_on>Thu Dec 03 15:02:12 +0100 2009</created_on>
103
    <updated_on>Sun Jan 03 12:08:41 +0100 2010</updated_on>
104
  </issue>
105 3 Christoph Witzany
  <issue>
106
    <id>4325</id>
107 1 Jean-Philippe Lang
    ...
108
  </issue>
109
</issues>
110 59 Toshi MARUYAMA
</code></pre>
111 1 Jean-Philippe Lang
112
h2. Showing an issue
113
114 31 Ilya Kulakov
<pre>
115 43 Jean-Philippe Lang
GET /issues/[id].[format]
116 31 Ilya Kulakov
</pre>
117
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
  * @attachments@
124
  * @relations@
125
  * @changesets@
126
  * @journals@ - See [[Rest_IssueJournals|Issue journals]] for more information.
127
  * @watchers@ - Since 2.3.0
128 1 Jean-Philippe Lang
129 43 Jean-Philippe Lang
+Examples+:
130
131
<pre>
132
GET /issues/2.xml
133
GET /issues/2.json
134
135
GET /issues/2.xml
136
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
140 1 Jean-Philippe Lang
h2. Creating an issue
141
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
  * @tracker_id@
150
  * @status_id@
151 50 redmineservices .
  * @priority_id@
152 45 Jean-Philippe Lang
  * @subject@
153
  * @description@
154
  * @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
  * @parent_issue_id@ - ID of the parent issue
158
  * @custom_fields@ - See [[Rest_api#Working-with-custom-fields|Custom fields]]
159
  * @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
  * @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
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
<?xml version="1.0"?>
170
<issue>
171
  <project_id>1</project_id>
172 1 Jean-Philippe Lang
  <subject>Example</subject>
173
  <priority_id>4</priority_id>
174 45 Jean-Philippe Lang
</issue>
175 59 Toshi MARUYAMA
</code></pre>
176 1 Jean-Philippe Lang
<pre>
177
POST /issues.json
178 59 Toshi MARUYAMA
</pre>
179
<pre><code class="json">
180 45 Jean-Philippe Lang
{
181
  "issue": {
182
    "project_id": 1,
183
    "subject": "Example",
184
    "priority_id": 4
185
  }
186
}
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
  * @tracker_id@
199
  * @status_id@
200
  * @subject@
201
  * ...
202
  * @notes@ - Comments about the update
203 54 Matt Wiseley
  * @private_notes@ - true if notes are private
204 1 Jean-Philippe Lang
205
Attachments can be added when you update an issue, see [[Rest_api#Attaching-files|Attaching files]].
206
207
+Examples+:
208
209 45 Jean-Philippe Lang
<pre>
210
PUT /issues/[id].xml
211 59 Toshi MARUYAMA
</pre>
212
213
<pre>
214
<code class="xml">
215 45 Jean-Philippe Lang
<?xml version="1.0"?>
216 1 Jean-Philippe Lang
<issue>
217
  <subject>Subject changed</subject>
218
  <notes>The subject was changed</notes>
219 45 Jean-Philippe Lang
</issue>
220 59 Toshi MARUYAMA
</code></pre>
221 45 Jean-Philippe Lang
222
<pre>
223
PUT /issues/[id].json
224 59 Toshi MARUYAMA
</pre>
225
226
<pre><code class="json">
227 45 Jean-Philippe Lang
{
228
  "issue": {
229
    "subject": "Subject changed",
230
    "notes": "The subject was changed"
231
  }
232 1 Jean-Philippe Lang
}
233 45 Jean-Philippe Lang
</pre>
234 44 Jean-Philippe Lang
235
h2. Deleting an issue
236
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
243 44 Jean-Philippe Lang
  POST /issues/[id]/watchers.[format]
244
245
+Parameters+:
246
247
* @user_id@ (required): id of the user to add as a watcher
248
249 1 Jean-Philippe Lang
h2. Removing a watcher
250 46 Jean-Philippe Lang
251
_Added in 2.3.0_
252 1 Jean-Philippe Lang
253
  DELETE /issues/[id]/watchers/[user_id].[format]
254
255
+Parameters+: _none_