Project

General

Profile

Rest Issues » History » Version 32

Ilya Kulakov, 2011-09-30 22:01

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