Rest Issues » History » Version 23

Alex Last, 2010-12-13 03:08
added a comment about paging in older redmine versions.

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