Rest Issues » History » Version 26

Etienne Massip, 2011-02-16 10:46

1 1 Jean-Philippe Lang
h1. Issues
2 1 Jean-Philippe Lang
3 1 Jean-Philippe Lang
h2. Listing issues
4 1 Jean-Philippe Lang
5 1 Jean-Philippe Lang
  GET /issues.xml
6 1 Jean-Philippe Lang
7 2 Jean-Philippe Lang
Returns a paginated list of issues. By default, it returns open issues only.
8 1 Jean-Philippe Lang
9 1 Jean-Philippe Lang
+Parameters+:
10 26 Etienne Massip
11 26 Etienne Massip
*Available as of version:1.1.0 :*
12 21 Alex Last
* @offset@: skip this number of issues in response (optional)
13 21 Alex Last
* @limit@: number of issues per page (optional)
14 2 Jean-Philippe Lang
15 24 Alex Last
*use this for "stable 1.0 branch"* (instead of "offset" and "limit"):
16 23 Alex Last
* @page@:  page number (optional)
17 23 Alex Last
18 2 Jean-Philippe Lang
Optional filters:
19 2 Jean-Philippe Lang
20 2 Jean-Philippe Lang
* @project_id@: get issues from the project with the given id
21 2 Jean-Philippe Lang
* @tracker_id@: get issues from the tracker with the given id
22 2 Jean-Philippe Lang
* @status_id@: get issues with the given status id only (you can use @*@ to get open and closed issues)
23 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.)
24 2 Jean-Philippe Lang
* ...
25 2 Jean-Philippe Lang
26 2 Jean-Philippe Lang
+Examples+:
27 2 Jean-Philippe Lang
28 2 Jean-Philippe Lang
<pre>
29 2 Jean-Philippe Lang
GET /issues.xml
30 2 Jean-Philippe Lang
GET /issues.xml?project_id=2
31 2 Jean-Philippe Lang
GET /issues.xml?project_id=2&tracker_id=1
32 18 Álvaro Arranz
GET /issues.xml?assigned_to=me
33 12 Robert Palmer
GET /issues.xml?status_id=closed
34 1 Jean-Philippe Lang
GET /issues.xml?status_id=*
35 25 John Manktelow
GET /issues.xml?cf_1=abcdef
36 21 Alex Last
37 21 Alex Last
Paging example:
38 21 Alex Last
GET /issues.xml?project_id=testproject&query_id=2&offset=0&limit=100
39 21 Alex Last
GET /issues.xml?project_id=testproject&query_id=2&offset=50&limit=100
40 2 Jean-Philippe Lang
</pre>
41 12 Robert Palmer
42 12 Robert Palmer
43 1 Jean-Philippe Lang
44 1 Jean-Philippe Lang
+Response+:
45 1 Jean-Philippe Lang
46 1 Jean-Philippe Lang
<pre>
47 1 Jean-Philippe Lang
<?xml version="1.0" encoding="UTF-8"?>
48 1 Jean-Philippe Lang
<issues type="array" count="1640">
49 3 Christoph Witzany
  <issue>
50 3 Christoph Witzany
    <id>4326</id>
51 1 Jean-Philippe Lang
    <project name="Redmine" id="1"/>
52 1 Jean-Philippe Lang
    <tracker name="Feature" id="2"/>
53 1 Jean-Philippe Lang
    <status name="New" id="1"/>
54 1 Jean-Philippe Lang
    <priority name="Normal" id="4"/>
55 1 Jean-Philippe Lang
    <author name="John Smith" id="10106"/>
56 1 Jean-Philippe Lang
    <category name="Email notifications" id="9"/>
57 1 Jean-Philippe Lang
    <subject>
58 1 Jean-Philippe Lang
      Aggregate Multiple Issue Changes for Email Notifications
59 1 Jean-Philippe Lang
    </subject>
60 1 Jean-Philippe Lang
    <description>
61 1 Jean-Philippe Lang
      This is not to be confused with another useful proposed feature that
62 1 Jean-Philippe Lang
      would do digest emails for notifications.
63 1 Jean-Philippe Lang
    </description>
64 1 Jean-Philippe Lang
    <start_date>2009-12-03</start_date>
65 1 Jean-Philippe Lang
    <due_date></due_date>
66 1 Jean-Philippe Lang
    <done_ratio>0</done_ratio>
67 1 Jean-Philippe Lang
    <estimated_hours></estimated_hours>
68 1 Jean-Philippe Lang
    <custom_fields>
69 1 Jean-Philippe Lang
      <custom_field name="Resolution" id="2">Duplicate</custom_field>
70 1 Jean-Philippe Lang
      <custom_field name="Texte" id="5">Test</custom_field>
71 1 Jean-Philippe Lang
      <custom_field name="Boolean" id="6">1</custom_field>
72 1 Jean-Philippe Lang
      <custom_field name="Date" id="7">2010-01-12</custom_field>
73 1 Jean-Philippe Lang
    </custom_fields>
74 1 Jean-Philippe Lang
    <created_on>Thu Dec 03 15:02:12 +0100 2009</created_on>
75 1 Jean-Philippe Lang
    <updated_on>Sun Jan 03 12:08:41 +0100 2010</updated_on>
76 1 Jean-Philippe Lang
  </issue>
77 3 Christoph Witzany
  <issue>
78 3 Christoph Witzany
    <id>4325</id>
79 1 Jean-Philippe Lang
    ...
80 1 Jean-Philippe Lang
  </issue>
81 1 Jean-Philippe Lang
</issues>
82 1 Jean-Philippe Lang
</pre>
83 1 Jean-Philippe Lang
84 1 Jean-Philippe Lang
h2. Showing an issue
85 1 Jean-Philippe Lang
86 1 Jean-Philippe Lang
  GET /issues/[id].xml
87 1 Jean-Philippe Lang
88 1 Jean-Philippe Lang
h2. Creating an issue
89 1 Jean-Philippe Lang
90 5 Damien Churchill
h3. Using XML
91 5 Damien Churchill
92 1 Jean-Philippe Lang
<pre>
93 10 Robert Palmer
  POST /issues.xml
94 1 Jean-Philippe Lang
  <?xml version="1.0"?>
95 9 Robert Palmer
  <issue>
96 9 Robert Palmer
    <subject>Example</subject>
97 11 Robert Palmer
    <project_id>1</project_id>
98 9 Robert Palmer
    <priority_id>4</priority_id>
99 9 Robert Palmer
  </issue>
100 9 Robert Palmer
</pre>
101 7 Robert Palmer
102 16 Ian Epperson
Other available tags:
103 15 Ian Epperson
* description
104 15 Ian Epperson
* category_id
105 1 Jean-Philippe Lang
* assigned_to_id - ID of the user to assign the issue to (currently no mechanism to assign by name)
106 16 Ian Epperson
* status_id
107 16 Ian Epperson
* ...
108 5 Damien Churchill
109 5 Damien Churchill
h3. Using JSON
110 5 Damien Churchill
111 5 Damien Churchill
  POST /issues.json
112 5 Damien Churchill
  {
113 5 Damien Churchill
    "issue": {
114 5 Damien Churchill
      "project_id": "example",
115 5 Damien Churchill
      "subject": "Test issue"
116 5 Damien Churchill
    }
117 5 Damien Churchill
}
118 5 Damien Churchill
119 1 Jean-Philippe Lang
120 1 Jean-Philippe Lang
h2. Updating an issue
121 5 Damien Churchill
122 5 Damien Churchill
h3. Using XML
123 1 Jean-Philippe Lang
124 5 Damien Churchill
  PUT /issues/[id].xml
125 5 Damien Churchill
126 5 Damien Churchill
h3. Using JSON
127 6 Robert Palmer
128 5 Damien Churchill
  PUT /issues/[id].json
129 5 Damien Churchill
  {
130 5 Damien Churchill
    "issue": {
131 20 Jean-Philippe Lang
      "subject": "Example issue (was: Test issue)",
132 20 Jean-Philippe Lang
      "notes": "Changing the subject"
133 20 Jean-Philippe Lang
    }
134 5 Damien Churchill
}
135 1 Jean-Philippe Lang
136 1 Jean-Philippe Lang
137 1 Jean-Philippe Lang
h2. Deleting an issue
138 1 Jean-Philippe Lang
139 4 Ryan Lovelett
  DELETE /issues/[id].xml