Project

General

Profile

Rest Issues » History » Version 24

Alex Last, 2010-12-13 03:08

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