Rest Issues » History » Version 33

Ilya Kulakov, 2011-09-30 22:04

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