Rest Issues » History » Version 42

Jean-Philippe Lang, 2013-01-30 21:53
Clean up

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