1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>Commands Syntax</title>
<link rel="stylesheet" href="common/style.css" type="text/css" />
<meta name="generator" content="DocBook XSL Stylesheets V1.73.0" />
<meta name="keywords" content="webissues, issue tracking, bug tracking, team collaboration, server" />
<link rel="start" href="index.html" title="The WebIssues Server Manual" />
<link rel="up" href="protocol.html" title="Appendix A. WebIssues Protocol Reference" />
<link rel="prev" href="protocol_format.html" title="Line Format" />
<link rel="next" href="protocol_arguments.html" title="Arguments" />
</head>
<body>
<div id="header">
<div id="header-bar">
<img id="header-logo" src="common/webissues.png" alt="WebIssues" />
<div id="header-title">The <span class="application">WebIssues Server</span> Manual</div>
<div id="header-abstract">Issue tracking and team collaboration system</div>
</div>
<div id="header-links"><a accesskey="h" href="index.html">Home</a> » <a accesskey="u" href="protocol.html"><span class="application">WebIssues</span> Protocol Reference</a></div>
</div>
<div class="navlinks">
<div class="navleft">« <a accesskey="p" href="protocol_format.html">Line Format</a></div>
<div class="navright"><a accesskey="n" href="protocol_arguments.html">Arguments</a> »</div>
</div>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="protocol_syntax"></a>Commands Syntax</h2>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="commands_system"></a>System Commands</h3>
</div>
</div>
</div>
<div class="variablelist">
<dl>
<dt>
<span class="term">HELLO</span>
</dt>
<dd>
<p>SERVER 'name' 'uuid'</p>
</dd>
<dt>
<span class="term">LOGIN 'login' 'password'</span>
</dt>
<dd>
<p>USER userId access</p>
</dd>
</dl>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="commands_user"></a>User Management</h3>
</div>
</div>
</div>
<div class="variablelist">
<dl>
<dt>
<span class="term">LIST USERS</span>
</dt>
<dd>
<p>U userId 'login' 'name' access</p>
<p>M userId projectId access</p>
</dd>
<dt>
<span class="term">ADD USER 'login' 'name' 'password'</span>
</dt>
<dd>
<p>ID userId</p>
</dd>
<dt>
<span class="term">SET PASSWORD userId 'password'</span>
</dt>
<dd>
<p>OK</p>
</dd>
<dt>
<span class="term">RENAME USER userId 'newName'</span>
</dt>
<dd>
<p>OK</p>
</dd>
<dt>
<span class="term">GRANT USER userId access</span>
</dt>
<dd>
<p>OK</p>
</dd>
<dt>
<span class="term">GRANT MEMBER userId projectId access</span>
</dt>
<dd>
<p>OK</p>
</dd>
</dl>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="commands_type"></a>Type Management</h3>
</div>
</div>
</div>
<div class="variablelist">
<dl>
<dt>
<span class="term">LIST TYPES</span>
</dt>
<dd>
<p>T typeId 'name'</p>
<p>A attributeId typeId 'name' 'definition'</p>
</dd>
<dt>
<span class="term">ADD TYPE 'name'</span>
</dt>
<dd>
<p>ID typeId</p>
</dd>
<dt>
<span class="term">RENAME TYPE typeId 'newName'</span>
</dt>
<dd>
<p>OK</p>
</dd>
<dt>
<span class="term">DELETE TYPE typeId</span>
</dt>
<dd>
<p>OK</p>
</dd>
<dt>
<span class="term">ADD ATTRIBUTE typeId 'name' 'definition'</span>
</dt>
<dd>
<p>ID attributeId</p>
</dd>
<dt>
<span class="term">RENAME ATTRIBUTE attributeId 'newName'</span>
</dt>
<dd>
<p>OK</p>
</dd>
<dt>
<span class="term">MODIFY ATTRIBUTE attributeId 'definition'</span>
</dt>
<dd>
<p>OK</p>
</dd>
<dt>
<span class="term">DELETE ATTRIBUTE attributeId</span>
</dt>
<dd>
<p>OK</p>
</dd>
</dl>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="commands_project"></a>Project Management</h3>
</div>
</div>
</div>
<div class="variablelist">
<dl>
<dt>
<span class="term">LIST PROJECTS</span>
</dt>
<dd>
<p>P projectId 'name'</p>
<p>F folderId projectId 'name' typeId stamp</p>
</dd>
<dt>
<span class="term">ADD PROJECT 'name'</span>
</dt>
<dd>
<p>ID projectId</p>
</dd>
<dt>
<span class="term">RENAME PROJECT projectId 'newName'</span>
</dt>
<dd>
<p>OK</p>
</dd>
<dt>
<span class="term">DELETE PROJECT projectId</span>
</dt>
<dd>
<p>OK</p>
</dd>
<dt>
<span class="term">ADD FOLDER projectId typeId 'name'</span>
</dt>
<dd>
<p>ID folderId</p>
</dd>
<dt>
<span class="term">RENAME FOLDER folderId 'newName'</span>
</dt>
<dd>
<p>OK</p>
</dd>
<dt>
<span class="term">DELETE FOLDER folderId</span>
</dt>
<dd>
<p>OK</p>
</dd>
</dl>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="commands_issue"></a>Issue Operations</h3>
</div>
</div>
</div>
<div class="variablelist">
<dl>
<dt>
<span class="term">LIST ISSUES folderId sinceStamp</span>
</dt>
<dd>
<p>I issueId folderId 'name' stamp createdDate createdUser modifiedDate modifiedUser</p>
<p>V attributeId issueId 'value'</p>
</dd>
<dt>
<span class="term">GET DETAILS issueId sinceStamp</span>
</dt>
<dd>
<p>I issueId folderId 'name' stamp createdDate createdUser modifiedDate modifiedUser</p>
<p>V attributeId issueId 'value'</p>
<p>C commentId issueId createdDate createdUser 'text'</p>
<p>A attachmentId issueId 'name' createdDate createdUser size 'description'</p>
<p>H changeId issueId modifiedDate modifiedUser attributeId 'oldValue' 'newValue'</p>
</dd>
<dt>
<span class="term">ADD ISSUE folderId 'name'</span>
</dt>
<dd>
<p>ID issueId</p>
</dd>
<dt>
<span class="term">RENAME ISSUE issueId 'newName'</span>
</dt>
<dd>
<p>ID changeId</p>
</dd>
<dt>
<span class="term">SET VALUE issueId attributeId 'newValue'</span>
</dt>
<dd>
<p>ID changeId</p>
</dd>
<dt>
<span class="term">ADD COMMENT issueId 'text'</span>
</dt>
<dd>
<p>ID commentId</p>
</dd>
<dt>
<span class="term">ADD ATTACHMENT issueId 'name' 'description'</span>
</dt>
<dd>
<p>ID attachmentId</p>
</dd>
<dt>
<span class="term">GET ATTACHMENT attachmentId</span>
</dt>
<dd>
<p>>binary response<</p>
</dd>
<dt>
<span class="term">FIND ITEM itemId</span>
</dt>
<dd>
<p>ID issueId</p>
</dd>
</dl>
</div>
</div>
</div>
<div class="navlinks">
<div class="navleft">« <a accesskey="p" href="protocol_format.html">Line Format</a></div>
<div class="navright"><a accesskey="n" href="protocol_arguments.html">Arguments</a> »</div>
</div>
<div id="copyright">
<p class="copyright">Copyright © 2007-2008 WebIssues Team</p>
</div>
</body>
</html>
|
