Rest Issues » History » Version 40

Matthias Lamoureux, 2012-12-19 15:22

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 1 Jean-Philippe Lang
  GET /issues.xml
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 26 Etienne Massip
*Available as of version:1.1.0 :*
14 21 Alex Last
* @offset@: skip this number of issues in response (optional)
15 21 Alex Last
* @limit@: number of issues per page (optional)
16 36 Emmanuel Bourgerie
* @sort@: column to sort with. Append @:desc@ to invert the order.
17 2 Jean-Philippe Lang
18 24 Alex Last
*use this for "stable 1.0 branch"* (instead of "offset" and "limit"):
19 23 Alex Last
* @page@:  page number (optional)
20 23 Alex Last
21 2 Jean-Philippe Lang
Optional filters:
22 2 Jean-Philippe Lang
23 30 Ilya Kulakov
* @project_id@: get issues from the project with the given id, where id is either project id or project identifier
24 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.
25 2 Jean-Philippe Lang
* @tracker_id@: get issues from the tracker with the given id
26 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
27 29 Michael Fuchs
* @assigned_to_id@: get issues which are assigned to the given user id
28 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.)
29 2 Jean-Philippe Lang
* ...
30 2 Jean-Philippe Lang
31 2 Jean-Philippe Lang
+Examples+:
32 2 Jean-Philippe Lang
33 2 Jean-Philippe Lang
<pre>
34 2 Jean-Philippe Lang
GET /issues.xml
35 2 Jean-Philippe Lang
GET /issues.xml?project_id=2
36 1 Jean-Philippe Lang
GET /issues.xml?project_id=2&tracker_id=1
37 29 Michael Fuchs
GET /issues.xml?assigned_to_id=6
38 12 Robert Palmer
GET /issues.xml?status_id=closed
39 1 Jean-Philippe Lang
GET /issues.xml?status_id=*
40 25 John Manktelow
GET /issues.xml?cf_1=abcdef
41 21 Alex Last
42 21 Alex Last
Paging example:
43 21 Alex Last
GET /issues.xml?project_id=testproject&query_id=2&offset=0&limit=100
44 21 Alex Last
GET /issues.xml?project_id=testproject&query_id=2&offset=50&limit=100
45 39 Sridhar P
46 39 Sridhar P
To fetch issues for a date range:
47 39 Sridhar P
GET /issues.xml?created_on=><2012-03-01|2012-03-07
48 2 Jean-Philippe Lang
</pre>
49 12 Robert Palmer
50 12 Robert Palmer
51 1 Jean-Philippe Lang
52 1 Jean-Philippe Lang
+Response+:
53 1 Jean-Philippe Lang
54 1 Jean-Philippe Lang
<pre>
55 1 Jean-Philippe Lang
<?xml version="1.0" encoding="UTF-8"?>
56 1 Jean-Philippe Lang
<issues type="array" count="1640">
57 3 Christoph Witzany
  <issue>
58 3 Christoph Witzany
    <id>4326</id>
59 1 Jean-Philippe Lang
    <project name="Redmine" id="1"/>
60 1 Jean-Philippe Lang
    <tracker name="Feature" id="2"/>
61 1 Jean-Philippe Lang
    <status name="New" id="1"/>
62 1 Jean-Philippe Lang
    <priority name="Normal" id="4"/>
63 1 Jean-Philippe Lang
    <author name="John Smith" id="10106"/>
64 1 Jean-Philippe Lang
    <category name="Email notifications" id="9"/>
65 1 Jean-Philippe Lang
    <subject>
66 1 Jean-Philippe Lang
      Aggregate Multiple Issue Changes for Email Notifications
67 1 Jean-Philippe Lang
    </subject>
68 1 Jean-Philippe Lang
    <description>
69 1 Jean-Philippe Lang
      This is not to be confused with another useful proposed feature that
70 1 Jean-Philippe Lang
      would do digest emails for notifications.
71 1 Jean-Philippe Lang
    </description>
72 1 Jean-Philippe Lang
    <start_date>2009-12-03</start_date>
73 1 Jean-Philippe Lang
    <due_date></due_date>
74 1 Jean-Philippe Lang
    <done_ratio>0</done_ratio>
75 1 Jean-Philippe Lang
    <estimated_hours></estimated_hours>
76 1 Jean-Philippe Lang
    <custom_fields>
77 1 Jean-Philippe Lang
      <custom_field name="Resolution" id="2">Duplicate</custom_field>
78 1 Jean-Philippe Lang
      <custom_field name="Texte" id="5">Test</custom_field>
79 1 Jean-Philippe Lang
      <custom_field name="Boolean" id="6">1</custom_field>
80 1 Jean-Philippe Lang
      <custom_field name="Date" id="7">2010-01-12</custom_field>
81 1 Jean-Philippe Lang
    </custom_fields>
82 1 Jean-Philippe Lang
    <created_on>Thu Dec 03 15:02:12 +0100 2009</created_on>
83 1 Jean-Philippe Lang
    <updated_on>Sun Jan 03 12:08:41 +0100 2010</updated_on>
84 1 Jean-Philippe Lang
  </issue>
85 3 Christoph Witzany
  <issue>
86 3 Christoph Witzany
    <id>4325</id>
87 1 Jean-Philippe Lang
    ...
88 1 Jean-Philippe Lang
  </issue>
89 1 Jean-Philippe Lang
</issues>
90 1 Jean-Philippe Lang
</pre>
91 1 Jean-Philippe Lang
92 1 Jean-Philippe Lang
h2. Showing an issue
93 1 Jean-Philippe Lang
94 31 Ilya Kulakov
h3. Using XML
95 31 Ilya Kulakov
96 31 Ilya Kulakov
<pre>
97 31 Ilya Kulakov
GET /issues/[id].xml
98 31 Ilya Kulakov
</pre>
99 31 Ilya Kulakov
100 31 Ilya Kulakov
h3. Using JSON
101 31 Ilya Kulakov
102 31 Ilya Kulakov
<pre>
103 31 Ilya Kulakov
GET /issues/[id].json
104 31 Ilya Kulakov
</pre>
105 31 Ilya Kulakov
106 31 Ilya Kulakov
+Parameters+:
107 31 Ilya Kulakov
108 31 Ilya Kulakov
*Available as of version:1.1.0 :*
109 34 Emmanuel Bourgerie
* @include@: fetch associated data (optional). Possible values: children, attachments, relations, changesets and journals. To fetch multiple associations use comma (e.g ?include=relations,journals). See [[Rest_IssueJournals|Issue journals]] for more information.
110 1 Jean-Philippe Lang
111 1 Jean-Philippe Lang
h2. Creating an issue
112 1 Jean-Philippe Lang
113 5 Damien Churchill
h3. Using XML
114 5 Damien Churchill
115 1 Jean-Philippe Lang
<pre>
116 10 Robert Palmer
  POST /issues.xml
117 1 Jean-Philippe Lang
  <?xml version="1.0"?>
118 9 Robert Palmer
  <issue>
119 9 Robert Palmer
    <subject>Example</subject>
120 11 Robert Palmer
    <project_id>1</project_id>
121 9 Robert Palmer
    <priority_id>4</priority_id>
122 9 Robert Palmer
  </issue>
123 9 Robert Palmer
</pre>
124 7 Robert Palmer
125 16 Ian Epperson
Other available tags:
126 15 Ian Epperson
* description
127 15 Ian Epperson
* category_id
128 1 Jean-Philippe Lang
* assigned_to_id - ID of the user to assign the issue to (currently no mechanism to assign by name)
129 16 Ian Epperson
* status_id
130 37 Charles Shapiro
* parent_issue_id - ID of the parent issue
131 16 Ian Epperson
* ...
132 5 Damien Churchill
133 38 Jean-Philippe Lang
Attachments can be added when you create an issue, see [[Rest_api#Attaching-files|Attaching files]].
134 38 Jean-Philippe Lang
135 5 Damien Churchill
h3. Using JSON
136 5 Damien Churchill
137 5 Damien Churchill
  POST /issues.json
138 5 Damien Churchill
  {
139 5 Damien Churchill
    "issue": {
140 5 Damien Churchill
      "project_id": "example",
141 27 Stéphane Schoorens
      "subject": "Test issue",
142 27 Stéphane Schoorens
      "custom_field_values":{
143 27 Stéphane Schoorens
                              "1":"1.1.3"  #the affected version field
144 27 Stéphane Schoorens
      }
145 5 Damien Churchill
    }
146 5 Damien Churchill
}
147 5 Damien Churchill
148 1 Jean-Philippe Lang
149 1 Jean-Philippe Lang
h2. Updating an issue
150 38 Jean-Philippe Lang
151 38 Jean-Philippe Lang
Attachments can be added when you update an issue, see [[Rest_api#Attaching-files|Attaching files]].
152 5 Damien Churchill
153 5 Damien Churchill
h3. Using XML
154 1 Jean-Philippe Lang
155 5 Damien Churchill
  PUT /issues/[id].xml
156 5 Damien Churchill
157 5 Damien Churchill
h3. Using JSON
158 6 Robert Palmer
159 5 Damien Churchill
  PUT /issues/[id].json
160 5 Damien Churchill
  {
161 5 Damien Churchill
    "issue": {
162 20 Jean-Philippe Lang
      "subject": "Example issue (was: Test issue)",
163 20 Jean-Philippe Lang
      "notes": "Changing the subject"
164 20 Jean-Philippe Lang
    }
165 5 Damien Churchill
}
166 1 Jean-Philippe Lang
167 1 Jean-Philippe Lang
168 1 Jean-Philippe Lang
h2. Deleting an issue
169 1 Jean-Philippe Lang
170 4 Ryan Lovelett
  DELETE /issues/[id].xml