Project

General

Profile

Rest Issues » History » Version 40

Matthias Lamoureux, 2012-12-19 15:22

1 1 Jean-Philippe Lang
h1. Issues
2
3 28 Jean-Philippe Lang
{{>toc}}
4
5 1 Jean-Philippe Lang
h2. Listing issues
6
7
  GET /issues.xml
8
9 2 Jean-Philippe Lang
Returns a paginated list of issues. By default, it returns open issues only.
10 1 Jean-Philippe Lang
11
+Parameters+:
12 26 Etienne Massip
13
*Available as of version:1.1.0 :*
14 21 Alex Last
* @offset@: skip this number of issues in response (optional)
15
* @limit@: number of issues per page (optional)
16 36 Emmanuel Bourgerie
* @sort@: column to sort with. Append @:desc@ to invert the order.
17 2 Jean-Philippe Lang
18 24 Alex Last
*use this for "stable 1.0 branch"* (instead of "offset" and "limit"):
19 23 Alex Last
* @page@:  page number (optional)
20
21 2 Jean-Philippe Lang
Optional filters:
22
23 30 Ilya Kulakov
* @project_id@: get issues from the project with the given id, where id is either project id or project identifier
24 40 Matthias Lamoureux
* @subproject_id@: get issues from the subproject with the given id. You can use @project_id=XXX&subproject_id=!*@ to get only the issues of a given project and none of its subprojects.
25 2 Jean-Philippe Lang
* @tracker_id@: get issues from the tracker with the given id
26 33 Ilya Kulakov
* @status_id@: get issues with the given status id only. Possible values: @open@, @closed@, @*@ to get open and closed issues, status id
27 29 Michael Fuchs
* @assigned_to_id@: get issues which are assigned to the given user id
28 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.)
29 2 Jean-Philippe Lang
* ...
30
31
+Examples+:
32
33
<pre>
34
GET /issues.xml
35
GET /issues.xml?project_id=2
36 1 Jean-Philippe Lang
GET /issues.xml?project_id=2&tracker_id=1
37 29 Michael Fuchs
GET /issues.xml?assigned_to_id=6
38 12 Robert Palmer
GET /issues.xml?status_id=closed
39 1 Jean-Philippe Lang
GET /issues.xml?status_id=*
40 25 John Manktelow
GET /issues.xml?cf_1=abcdef
41 21 Alex Last
42
Paging example:
43
GET /issues.xml?project_id=testproject&query_id=2&offset=0&limit=100
44
GET /issues.xml?project_id=testproject&query_id=2&offset=50&limit=100
45 39 Sridhar P
46
To fetch issues for a date range:
47
GET /issues.xml?created_on=><2012-03-01|2012-03-07
48 2 Jean-Philippe Lang
</pre>
49 12 Robert Palmer
50
51 1 Jean-Philippe Lang
52
+Response+:
53
54
<pre>
55
<?xml version="1.0" encoding="UTF-8"?>
56
<issues type="array" count="1640">
57 3 Christoph Witzany
  <issue>
58
    <id>4326</id>
59 1 Jean-Philippe Lang
    <project name="Redmine" id="1"/>
60
    <tracker name="Feature" id="2"/>
61
    <status name="New" id="1"/>
62
    <priority name="Normal" id="4"/>
63
    <author name="John Smith" id="10106"/>
64
    <category name="Email notifications" id="9"/>
65
    <subject>
66
      Aggregate Multiple Issue Changes for Email Notifications
67
    </subject>
68
    <description>
69
      This is not to be confused with another useful proposed feature that
70
      would do digest emails for notifications.
71
    </description>
72
    <start_date>2009-12-03</start_date>
73
    <due_date></due_date>
74
    <done_ratio>0</done_ratio>
75
    <estimated_hours></estimated_hours>
76
    <custom_fields>
77
      <custom_field name="Resolution" id="2">Duplicate</custom_field>
78
      <custom_field name="Texte" id="5">Test</custom_field>
79
      <custom_field name="Boolean" id="6">1</custom_field>
80
      <custom_field name="Date" id="7">2010-01-12</custom_field>
81
    </custom_fields>
82
    <created_on>Thu Dec 03 15:02:12 +0100 2009</created_on>
83
    <updated_on>Sun Jan 03 12:08:41 +0100 2010</updated_on>
84
  </issue>
85 3 Christoph Witzany
  <issue>
86
    <id>4325</id>
87 1 Jean-Philippe Lang
    ...
88
  </issue>
89
</issues>
90
</pre>
91
92
h2. Showing an issue
93
94 31 Ilya Kulakov
h3. Using XML
95
96
<pre>
97
GET /issues/[id].xml
98
</pre>
99
100
h3. Using JSON
101
102
<pre>
103
GET /issues/[id].json
104
</pre>
105
106
+Parameters+:
107
108
*Available as of version:1.1.0 :*
109 34 Emmanuel Bourgerie
* @include@: fetch associated data (optional). Possible values: children, attachments, relations, changesets and journals. To fetch multiple associations use comma (e.g ?include=relations,journals). See [[Rest_IssueJournals|Issue journals]] for more information.
110 1 Jean-Philippe Lang
111
h2. Creating an issue
112
113 5 Damien Churchill
h3. Using XML
114
115 1 Jean-Philippe Lang
<pre>
116 10 Robert Palmer
  POST /issues.xml
117 1 Jean-Philippe Lang
  <?xml version="1.0"?>
118 9 Robert Palmer
  <issue>
119
    <subject>Example</subject>
120 11 Robert Palmer
    <project_id>1</project_id>
121 9 Robert Palmer
    <priority_id>4</priority_id>
122
  </issue>
123
</pre>
124 7 Robert Palmer
125 16 Ian Epperson
Other available tags:
126 15 Ian Epperson
* description
127
* category_id
128 1 Jean-Philippe Lang
* assigned_to_id - ID of the user to assign the issue to (currently no mechanism to assign by name)
129 16 Ian Epperson
* status_id
130 37 Charles Shapiro
* parent_issue_id - ID of the parent issue
131 16 Ian Epperson
* ...
132 5 Damien Churchill
133 38 Jean-Philippe Lang
Attachments can be added when you create an issue, see [[Rest_api#Attaching-files|Attaching files]].
134
135 5 Damien Churchill
h3. Using JSON
136
137
  POST /issues.json
138
  {
139
    "issue": {
140
      "project_id": "example",
141 27 Stéphane Schoorens
      "subject": "Test issue",
142
      "custom_field_values":{
143
                              "1":"1.1.3"  #the affected version field
144
      }
145 5 Damien Churchill
    }
146
}
147
148 1 Jean-Philippe Lang
149
h2. Updating an issue
150 38 Jean-Philippe Lang
151
Attachments can be added when you update an issue, see [[Rest_api#Attaching-files|Attaching files]].
152 5 Damien Churchill
153
h3. Using XML
154 1 Jean-Philippe Lang
155 5 Damien Churchill
  PUT /issues/[id].xml
156
157
h3. Using JSON
158 6 Robert Palmer
159 5 Damien Churchill
  PUT /issues/[id].json
160
  {
161
    "issue": {
162 20 Jean-Philippe Lang
      "subject": "Example issue (was: Test issue)",
163
      "notes": "Changing the subject"
164
    }
165 5 Damien Churchill
}
166 1 Jean-Philippe Lang
167
168
h2. Deleting an issue
169
170 4 Ryan Lovelett
  DELETE /issues/[id].xml