Rest Issues » History » Version 28

Jean-Philippe Lang, 2011-08-01 17:55
toc added

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