Rest Issues » History » Version 25

John Manktelow, 2011-01-30 00:00
Added example for filtering by a custom field

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