@docbrasil/api-systemmanager 1.1.60 → 1.1.62
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/api/user/index.js +3 -0
- package/api/user/kanban.js +510 -0
- package/dist/bundle.cjs +504 -0
- package/dist/bundle.mjs +1 -1
- package/doc/api.md +354 -24
- package/docs/Admin.html +1 -1
- package/docs/AdminDocuments.html +1 -1
- package/docs/AdminForm.html +1 -1
- package/docs/AdminLists.html +1 -1
- package/docs/AdminMessage.html +1 -1
- package/docs/AdminNotification.html +1 -1
- package/docs/AdminPlugin.html +1 -1
- package/docs/AdminPolicy.html +1 -1
- package/docs/AdminProcesses.html +1 -1
- package/docs/AdminTask.html +1 -1
- package/docs/AdminUser.html +1 -1
- package/docs/Application.html +1 -1
- package/docs/Chart.html +1 -1
- package/docs/Dashboard.html +1 -1
- package/docs/Datasource.html +1 -1
- package/docs/Dispatch.html +132 -41
- package/docs/Documents.html +8 -8
- package/docs/External.html +1 -1
- package/docs/GeoLocation.html +1 -1
- package/docs/Help.html +1 -1
- package/docs/Kanban.html +3038 -0
- package/docs/Login.html +2 -2
- package/docs/MyTasks.html +1 -1
- package/docs/MyndAI.html +1 -1
- package/docs/Notification.html +1 -1
- package/docs/Organization.html +1 -1
- package/docs/Page.html +1 -1
- package/docs/Process.html +1 -1
- package/docs/Register.html +1 -1
- package/docs/Session.html +1 -1
- package/docs/Settings.html +1 -1
- package/docs/Task.html +1 -1
- package/docs/TaskAvailable.html +1 -1
- package/docs/Updates.html +1 -1
- package/docs/User.html +1 -1
- package/docs/Users.html +2 -2
- package/docs/admin_doctypes.js.html +2 -2
- package/docs/admin_document.js.html +2 -2
- package/docs/admin_form.js.html +2 -2
- package/docs/admin_index.js.html +1 -1
- package/docs/admin_list.js.html +2 -2
- package/docs/admin_message.js.html +2 -2
- package/docs/admin_notification.js.html +2 -2
- package/docs/admin_organization.js.html +2 -2
- package/docs/admin_plugin.js.html +2 -2
- package/docs/admin_policy.js.html +1 -1
- package/docs/admin_processes.js.html +2 -2
- package/docs/admin_task.js.html +2 -2
- package/docs/admin_user.js.html +2 -2
- package/docs/ai.js.html +2 -2
- package/docs/dispatch.js.html +75 -78
- package/docs/external.js.html +2 -2
- package/docs/general_geoLocation.js.html +2 -2
- package/docs/general_index.js.html +1 -1
- package/docs/index.html +1 -1
- package/docs/login.js.html +3 -3
- package/docs/session.js.html +2 -2
- package/docs/user_application.js.html +2 -2
- package/docs/user_dashboard.js.html +2 -2
- package/docs/user_datasource.js.html +2 -2
- package/docs/user_document.js.html +5 -4
- package/docs/user_help.js.html +2 -2
- package/docs/user_index.js.html +4 -1
- package/docs/user_kanban.js.html +627 -0
- package/docs/user_my_tasks.js.html +9 -9
- package/docs/user_notification.js.html +2 -2
- package/docs/user_organization.js.html +3 -3
- package/docs/user_page.js.html +2 -2
- package/docs/user_process.js.html +14 -14
- package/docs/user_register.js.html +2 -2
- package/docs/user_settings.js.html +2 -2
- package/docs/user_task.js.html +2 -2
- package/docs/user_task_available.js.html +2 -2
- package/docs/user_updates.js.html +2 -2
- package/docs/user_user.js.html +2 -2
- package/docs/utils_promises.js.html +1 -1
- package/package.json +1 -1
package/docs/Kanban.html
ADDED
|
@@ -0,0 +1,3038 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
|
|
4
|
+
<head>
|
|
5
|
+
|
|
6
|
+
<meta charset="utf-8">
|
|
7
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
8
|
+
<title> Kanban</title>
|
|
9
|
+
|
|
10
|
+
<script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
|
|
11
|
+
<script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
|
|
12
|
+
<script src="./build/entry.js"></script>
|
|
13
|
+
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
|
|
14
|
+
<!--[if lt IE 9]>
|
|
15
|
+
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
16
|
+
<![endif]-->
|
|
17
|
+
<link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
|
|
18
|
+
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
|
|
19
|
+
<link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
|
|
20
|
+
<link type="text/css" rel="stylesheet" href="styles/app.min.css">
|
|
21
|
+
<link type="text/css" rel="stylesheet" href="styles/iframe.css">
|
|
22
|
+
<link type="text/css" rel="stylesheet" href="">
|
|
23
|
+
<script async defer src="https://buttons.github.io/buttons.js"></script>
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
</head>
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
<body class="layout small-header">
|
|
31
|
+
<div id="stickyNavbarOverlay"></div>
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
<div class="top-nav">
|
|
35
|
+
<div class="inner">
|
|
36
|
+
<a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
|
|
37
|
+
<span aria-hidden="true"></span>
|
|
38
|
+
<span aria-hidden="true"></span>
|
|
39
|
+
<span aria-hidden="true"></span>
|
|
40
|
+
</a>
|
|
41
|
+
<div class="logo">
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
<div class="menu">
|
|
46
|
+
|
|
47
|
+
<div class="navigation">
|
|
48
|
+
<a
|
|
49
|
+
href="index.html"
|
|
50
|
+
class="link"
|
|
51
|
+
>
|
|
52
|
+
Documentation
|
|
53
|
+
</a>
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
</div>
|
|
58
|
+
</div>
|
|
59
|
+
</div>
|
|
60
|
+
</div>
|
|
61
|
+
<div id="main">
|
|
62
|
+
<div
|
|
63
|
+
class="sidebar "
|
|
64
|
+
id="sidebarNav"
|
|
65
|
+
>
|
|
66
|
+
|
|
67
|
+
<nav>
|
|
68
|
+
|
|
69
|
+
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="Admin.html">Admin</a></li><li><a href="AdminDocuments.html">AdminDocuments</a></li><li><a href="AdminForm.html">AdminForm</a></li><li><a href="AdminLists.html">AdminLists</a></li><li><a href="AdminMessage.html">AdminMessage</a></li><li><a href="AdminNotification.html">AdminNotification</a></li><li><a href="AdminPlugin.html">AdminPlugin</a></li><li><a href="AdminPolicy.html">AdminPolicy</a></li><li><a href="AdminProcesses.html">AdminProcesses</a></li><li><a href="AdminTask.html">AdminTask</a></li><li><a href="AdminUser.html">AdminUser</a></li><li><a href="Application.html">Application</a></li><li><a href="Chart.html">Chart</a></li><li><a href="Dashboard.html">Dashboard</a></li><li><a href="Datasource.html">Datasource</a></li><li><a href="Dispatch.html">Dispatch</a></li><li><a href="Documents.html">Documents</a></li><li><a href="External.html">External</a></li><li><a href="GeoLocation.html">GeoLocation</a></li><li><a href="Help.html">Help</a></li><li><a href="Kanban.html">Kanban</a></li><li><a href="Login.html">Login</a></li><li><a href="MyTasks.html">MyTasks</a></li><li><a href="MyndAI.html">MyndAI</a></li><li><a href="Notification.html">Notification</a></li><li><a href="Organization.html">Organization</a></li><li><a href="Page.html">Page</a></li><li><a href="Process.html">Process</a></li><li><a href="Register.html">Register</a></li><li><a href="Session.html">Session</a></li><li><a href="Settings.html">Settings</a></li><li><a href="Task.html">Task</a></li><li><a href="TaskAvailable.html">TaskAvailable</a></li><li><a href="Updates.html">Updates</a></li><li><a href="User.html">User</a></li><li><a href="Users.html">Users</a></li></ul></div>
|
|
70
|
+
|
|
71
|
+
</nav>
|
|
72
|
+
</div>
|
|
73
|
+
<div class="core" id="main-content-wrapper">
|
|
74
|
+
<div class="content">
|
|
75
|
+
<header class="page-title">
|
|
76
|
+
<p>Class</p>
|
|
77
|
+
<h1>Kanban</h1>
|
|
78
|
+
</header>
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
<section>
|
|
85
|
+
|
|
86
|
+
<header>
|
|
87
|
+
|
|
88
|
+
<h2><span class="attribs"><span class="type-signature"></span></span>Kanban<span class="signature">()</span><span class="type-signature"></span></h2>
|
|
89
|
+
|
|
90
|
+
<div class="class-description">Class for task, permission user</div>
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
</header>
|
|
94
|
+
|
|
95
|
+
<article>
|
|
96
|
+
<div class="container-overview">
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
<div class='vertical-section'>
|
|
100
|
+
<div class="members">
|
|
101
|
+
<div class="member">
|
|
102
|
+
<div class=name>
|
|
103
|
+
<span class="tag">Constructor</span>
|
|
104
|
+
</div>
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
<h4 class="name" id="Kanban">
|
|
110
|
+
<a class="href-link" href="#Kanban">#</a>
|
|
111
|
+
|
|
112
|
+
<span class="code-name">
|
|
113
|
+
|
|
114
|
+
new Kanban<span class="signature">()</span><span class="type-signature"></span>
|
|
115
|
+
|
|
116
|
+
</span>
|
|
117
|
+
</h4>
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
<dl class="details">
|
|
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
|
+
<p class="tag-source">
|
|
168
|
+
<a href="user_kanban.js.html" class="button">View Source</a>
|
|
169
|
+
<span>
|
|
170
|
+
<a href="user_kanban.js.html">user/kanban.js</a>, <a href="user_kanban.js.html#line11">line 11</a>
|
|
171
|
+
</span>
|
|
172
|
+
</p>
|
|
173
|
+
|
|
174
|
+
</dl>
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
</div>
|
|
198
|
+
</div>
|
|
199
|
+
</div>
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
</div>
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
<div class='vertical-section'>
|
|
220
|
+
<h1>Methods</h1>
|
|
221
|
+
<div class="members">
|
|
222
|
+
|
|
223
|
+
<div class="member">
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
<h4 class="name" id="addTaskTag">
|
|
228
|
+
<a class="href-link" href="#addTaskTag">#</a>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
<span class='tag'>async</span>
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
<span class="code-name">
|
|
235
|
+
|
|
236
|
+
addTaskTag<span class="signature">(params, session)</span><span class="type-signature"> → {promise|Object|boolean|string}</span>
|
|
237
|
+
|
|
238
|
+
</span>
|
|
239
|
+
</h4>
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
<div class="description">
|
|
245
|
+
Adds a tag to a task on the Kanban board without creating duplicates
|
|
246
|
+
</div>
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
<h5>Parameters:</h5>
|
|
258
|
+
|
|
259
|
+
<div class="table-container">
|
|
260
|
+
<table class="params table">
|
|
261
|
+
<thead>
|
|
262
|
+
<tr>
|
|
263
|
+
|
|
264
|
+
<th>Name</th>
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
<th>Type</th>
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
<th class="last">Description</th>
|
|
274
|
+
</tr>
|
|
275
|
+
</thead>
|
|
276
|
+
|
|
277
|
+
<tbody>
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
<tr class="deep-level-0">
|
|
282
|
+
|
|
283
|
+
<td class="name"><code>params</code></td>
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
<td class="type">
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
<code class="param-type">Object</code>
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
</td>
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
<td class="description last">Parameters object</td>
|
|
300
|
+
</tr>
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
<tr class="deep-level-1">
|
|
306
|
+
|
|
307
|
+
<td class="name"><code>orgId</code></td>
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
<td class="type">
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
<code class="param-type">string</code>
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
</td>
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
<td class="description last">Organization id (_id database)</td>
|
|
324
|
+
</tr>
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
<tr class="deep-level-1">
|
|
329
|
+
|
|
330
|
+
<td class="name"><code>taskId</code></td>
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
<td class="type">
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
<code class="param-type">string</code>
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
</td>
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
<td class="description last">The ID of the task to update</td>
|
|
347
|
+
</tr>
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
<tr class="deep-level-1">
|
|
352
|
+
|
|
353
|
+
<td class="name"><code>tag</code></td>
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
<td class="type">
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
<code class="param-type">string</code>
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
</td>
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
<td class="description last">The tag to add to the task</td>
|
|
370
|
+
</tr>
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
<tr class="deep-level-0">
|
|
379
|
+
|
|
380
|
+
<td class="name"><code>session</code></td>
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
<td class="type">
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
<code class="param-type">string</code>
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
</td>
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
<td class="description last">Session, token JWT</td>
|
|
397
|
+
</tr>
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
</tbody>
|
|
402
|
+
</table>
|
|
403
|
+
</div>
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
<dl class="details">
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
<dt class="tag-author">Author:</dt>
|
|
429
|
+
<dd class="tag-author">
|
|
430
|
+
<ul>
|
|
431
|
+
<li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
|
|
432
|
+
</ul>
|
|
433
|
+
</dd>
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
<p class="tag-source">
|
|
449
|
+
<a href="user_kanban.js.html" class="button">View Source</a>
|
|
450
|
+
<span>
|
|
451
|
+
<a href="user_kanban.js.html">user/kanban.js</a>, <a href="user_kanban.js.html#line351">line 351</a>
|
|
452
|
+
</span>
|
|
453
|
+
</p>
|
|
454
|
+
|
|
455
|
+
</dl>
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
<div class='columns method-parameter'>
|
|
475
|
+
<div class="column is-2"><label>Returns:</label></div>
|
|
476
|
+
<div class="column is-10">
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
<div class="columns">
|
|
481
|
+
|
|
482
|
+
<div class='param-desc column is-7'>Promise that resolves to operation status</div>
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
<div class='column is-5 has-text-left'>
|
|
486
|
+
<label>Type: </label>
|
|
487
|
+
|
|
488
|
+
<code class="param-type">promise</code>
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
</div>
|
|
492
|
+
|
|
493
|
+
</div>
|
|
494
|
+
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
<div class="columns">
|
|
499
|
+
|
|
500
|
+
<div class='param-desc column is-7'>returns.data - The response data containing:</div>
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
<div class='column is-5 has-text-left'>
|
|
504
|
+
<label>Type: </label>
|
|
505
|
+
|
|
506
|
+
<code class="param-type">Object</code>
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
</div>
|
|
510
|
+
|
|
511
|
+
</div>
|
|
512
|
+
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
<div class="columns">
|
|
517
|
+
|
|
518
|
+
<div class='param-desc column is-7'>returns.data.success - Indicates if the operation was successful</div>
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
<div class='column is-5 has-text-left'>
|
|
522
|
+
<label>Type: </label>
|
|
523
|
+
|
|
524
|
+
<code class="param-type">boolean</code>
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
</div>
|
|
528
|
+
|
|
529
|
+
</div>
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
<div class="columns">
|
|
535
|
+
|
|
536
|
+
<div class='param-desc column is-7'>[returns.data.error] - Error message if operation failed</div>
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
<div class='column is-5 has-text-left'>
|
|
540
|
+
<label>Type: </label>
|
|
541
|
+
|
|
542
|
+
<code class="param-type">string</code>
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
</div>
|
|
546
|
+
|
|
547
|
+
</div>
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
</div>
|
|
551
|
+
</div>
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
<h5>Example</h5>
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
<pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
|
|
560
|
+
const api = new API();
|
|
561
|
+
const params = {
|
|
562
|
+
orgId: '55e4a3bd6be6b45210833fae',
|
|
563
|
+
taskId: '507f1f77bcf86cd799439011',
|
|
564
|
+
tag: 'urgent'
|
|
565
|
+
};
|
|
566
|
+
const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
567
|
+
const result = await api.user.kanban.addTaskTag(params, session);
|
|
568
|
+
|
|
569
|
+
Expected response structure (success):
|
|
570
|
+
{
|
|
571
|
+
success: true
|
|
572
|
+
}
|
|
573
|
+
|
|
574
|
+
Expected response structure (error):
|
|
575
|
+
{
|
|
576
|
+
success: false,
|
|
577
|
+
error: "Task not found"
|
|
578
|
+
}</code></pre>
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
</div>
|
|
583
|
+
|
|
584
|
+
<div class="member">
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
<h4 class="name" id="get">
|
|
589
|
+
<a class="href-link" href="#get">#</a>
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
<span class='tag'>async</span>
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
<span class="code-name">
|
|
596
|
+
|
|
597
|
+
get<span class="signature">(params, session)</span><span class="type-signature"> → {promise|Object|boolean|Array|string|string|boolean|Array|Array}</span>
|
|
598
|
+
|
|
599
|
+
</span>
|
|
600
|
+
</h4>
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
<div class="description">
|
|
606
|
+
Retrieves the Kanban board data for a specified organization process
|
|
607
|
+
</div>
|
|
608
|
+
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
<h5>Parameters:</h5>
|
|
619
|
+
|
|
620
|
+
<div class="table-container">
|
|
621
|
+
<table class="params table">
|
|
622
|
+
<thead>
|
|
623
|
+
<tr>
|
|
624
|
+
|
|
625
|
+
<th>Name</th>
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
<th>Type</th>
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
<th class="last">Description</th>
|
|
635
|
+
</tr>
|
|
636
|
+
</thead>
|
|
637
|
+
|
|
638
|
+
<tbody>
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
<tr class="deep-level-0">
|
|
643
|
+
|
|
644
|
+
<td class="name"><code>params</code></td>
|
|
645
|
+
|
|
646
|
+
|
|
647
|
+
<td class="type">
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
<code class="param-type">Object</code>
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
</td>
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
<td class="description last">Parameters object</td>
|
|
661
|
+
</tr>
|
|
662
|
+
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
<tr class="deep-level-1">
|
|
667
|
+
|
|
668
|
+
<td class="name"><code>orgId</code></td>
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
<td class="type">
|
|
672
|
+
|
|
673
|
+
|
|
674
|
+
<code class="param-type">string</code>
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
</td>
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
<td class="description last">Organization id (_id database)</td>
|
|
685
|
+
</tr>
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
<tr class="deep-level-1">
|
|
690
|
+
|
|
691
|
+
<td class="name"><code>orgProcessName</code></td>
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
<td class="type">
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
<code class="param-type">string</code>
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
</td>
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
<td class="description last">The name of the organization process</td>
|
|
708
|
+
</tr>
|
|
709
|
+
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
<tr class="deep-level-1">
|
|
713
|
+
|
|
714
|
+
<td class="name"><code>flowId</code></td>
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
<td class="type">
|
|
718
|
+
|
|
719
|
+
|
|
720
|
+
<code class="param-type">string</code>
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
</td>
|
|
725
|
+
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
<td class="description last">Flow id for the specific kanban flow</td>
|
|
731
|
+
</tr>
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
|
|
737
|
+
|
|
738
|
+
|
|
739
|
+
<tr class="deep-level-0">
|
|
740
|
+
|
|
741
|
+
<td class="name"><code>session</code></td>
|
|
742
|
+
|
|
743
|
+
|
|
744
|
+
<td class="type">
|
|
745
|
+
|
|
746
|
+
|
|
747
|
+
<code class="param-type">string</code>
|
|
748
|
+
|
|
749
|
+
|
|
750
|
+
|
|
751
|
+
</td>
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
|
|
755
|
+
|
|
756
|
+
|
|
757
|
+
<td class="description last">Session, token JWT</td>
|
|
758
|
+
</tr>
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
|
|
762
|
+
</tbody>
|
|
763
|
+
</table>
|
|
764
|
+
</div>
|
|
765
|
+
|
|
766
|
+
|
|
767
|
+
|
|
768
|
+
|
|
769
|
+
|
|
770
|
+
<dl class="details">
|
|
771
|
+
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
|
|
776
|
+
|
|
777
|
+
|
|
778
|
+
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
|
|
786
|
+
|
|
787
|
+
|
|
788
|
+
|
|
789
|
+
<dt class="tag-author">Author:</dt>
|
|
790
|
+
<dd class="tag-author">
|
|
791
|
+
<ul>
|
|
792
|
+
<li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
|
|
793
|
+
</ul>
|
|
794
|
+
</dd>
|
|
795
|
+
|
|
796
|
+
|
|
797
|
+
|
|
798
|
+
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
|
|
805
|
+
|
|
806
|
+
|
|
807
|
+
|
|
808
|
+
|
|
809
|
+
<p class="tag-source">
|
|
810
|
+
<a href="user_kanban.js.html" class="button">View Source</a>
|
|
811
|
+
<span>
|
|
812
|
+
<a href="user_kanban.js.html">user/kanban.js</a>, <a href="user_kanban.js.html#line108">line 108</a>
|
|
813
|
+
</span>
|
|
814
|
+
</p>
|
|
815
|
+
|
|
816
|
+
</dl>
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
|
|
823
|
+
|
|
824
|
+
|
|
825
|
+
|
|
826
|
+
|
|
827
|
+
|
|
828
|
+
|
|
829
|
+
|
|
830
|
+
|
|
831
|
+
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
<div class='columns method-parameter'>
|
|
836
|
+
<div class="column is-2"><label>Returns:</label></div>
|
|
837
|
+
<div class="column is-10">
|
|
838
|
+
|
|
839
|
+
|
|
840
|
+
|
|
841
|
+
<div class="columns">
|
|
842
|
+
|
|
843
|
+
<div class='param-desc column is-7'>Promise that resolves to Kanban board data</div>
|
|
844
|
+
|
|
845
|
+
|
|
846
|
+
<div class='column is-5 has-text-left'>
|
|
847
|
+
<label>Type: </label>
|
|
848
|
+
|
|
849
|
+
<code class="param-type">promise</code>
|
|
850
|
+
|
|
851
|
+
|
|
852
|
+
</div>
|
|
853
|
+
|
|
854
|
+
</div>
|
|
855
|
+
|
|
856
|
+
|
|
857
|
+
|
|
858
|
+
|
|
859
|
+
<div class="columns">
|
|
860
|
+
|
|
861
|
+
<div class='param-desc column is-7'>returns.data - The response data containing:</div>
|
|
862
|
+
|
|
863
|
+
|
|
864
|
+
<div class='column is-5 has-text-left'>
|
|
865
|
+
<label>Type: </label>
|
|
866
|
+
|
|
867
|
+
<code class="param-type">Object</code>
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
</div>
|
|
871
|
+
|
|
872
|
+
</div>
|
|
873
|
+
|
|
874
|
+
|
|
875
|
+
|
|
876
|
+
|
|
877
|
+
<div class="columns">
|
|
878
|
+
|
|
879
|
+
<div class='param-desc column is-7'>returns.data.success - Indicates if the operation was successful</div>
|
|
880
|
+
|
|
881
|
+
|
|
882
|
+
<div class='column is-5 has-text-left'>
|
|
883
|
+
<label>Type: </label>
|
|
884
|
+
|
|
885
|
+
<code class="param-type">boolean</code>
|
|
886
|
+
|
|
887
|
+
|
|
888
|
+
</div>
|
|
889
|
+
|
|
890
|
+
</div>
|
|
891
|
+
|
|
892
|
+
|
|
893
|
+
|
|
894
|
+
|
|
895
|
+
<div class="columns">
|
|
896
|
+
|
|
897
|
+
<div class='param-desc column is-7'>returns.data.kanban - Array of status columns with their tasks</div>
|
|
898
|
+
|
|
899
|
+
|
|
900
|
+
<div class='column is-5 has-text-left'>
|
|
901
|
+
<label>Type: </label>
|
|
902
|
+
|
|
903
|
+
<code class="param-type">Array</code>
|
|
904
|
+
|
|
905
|
+
|
|
906
|
+
</div>
|
|
907
|
+
|
|
908
|
+
</div>
|
|
909
|
+
|
|
910
|
+
|
|
911
|
+
|
|
912
|
+
|
|
913
|
+
<div class="columns">
|
|
914
|
+
|
|
915
|
+
<div class='param-desc column is-7'>returns.data.kanban[].id - Unique identifier for the status column</div>
|
|
916
|
+
|
|
917
|
+
|
|
918
|
+
<div class='column is-5 has-text-left'>
|
|
919
|
+
<label>Type: </label>
|
|
920
|
+
|
|
921
|
+
<code class="param-type">string</code>
|
|
922
|
+
|
|
923
|
+
|
|
924
|
+
</div>
|
|
925
|
+
|
|
926
|
+
</div>
|
|
927
|
+
|
|
928
|
+
|
|
929
|
+
|
|
930
|
+
|
|
931
|
+
<div class="columns">
|
|
932
|
+
|
|
933
|
+
<div class='param-desc column is-7'>returns.data.kanban[].title - Display title of the status column</div>
|
|
934
|
+
|
|
935
|
+
|
|
936
|
+
<div class='column is-5 has-text-left'>
|
|
937
|
+
<label>Type: </label>
|
|
938
|
+
|
|
939
|
+
<code class="param-type">string</code>
|
|
940
|
+
|
|
941
|
+
|
|
942
|
+
</div>
|
|
943
|
+
|
|
944
|
+
</div>
|
|
945
|
+
|
|
946
|
+
|
|
947
|
+
|
|
948
|
+
|
|
949
|
+
<div class="columns">
|
|
950
|
+
|
|
951
|
+
<div class='param-desc column is-7'>returns.data.kanban[].isExpanded - Whether the status column is expanded or collapsed</div>
|
|
952
|
+
|
|
953
|
+
|
|
954
|
+
<div class='column is-5 has-text-left'>
|
|
955
|
+
<label>Type: </label>
|
|
956
|
+
|
|
957
|
+
<code class="param-type">boolean</code>
|
|
958
|
+
|
|
959
|
+
|
|
960
|
+
</div>
|
|
961
|
+
|
|
962
|
+
</div>
|
|
963
|
+
|
|
964
|
+
|
|
965
|
+
|
|
966
|
+
|
|
967
|
+
<div class="columns">
|
|
968
|
+
|
|
969
|
+
<div class='param-desc column is-7'>returns.data.kanban[].taskList - Array of tasks within this status column</div>
|
|
970
|
+
|
|
971
|
+
|
|
972
|
+
<div class='column is-5 has-text-left'>
|
|
973
|
+
<label>Type: </label>
|
|
974
|
+
|
|
975
|
+
<code class="param-type">Array</code>
|
|
976
|
+
|
|
977
|
+
|
|
978
|
+
</div>
|
|
979
|
+
|
|
980
|
+
</div>
|
|
981
|
+
|
|
982
|
+
|
|
983
|
+
|
|
984
|
+
|
|
985
|
+
<div class="columns">
|
|
986
|
+
|
|
987
|
+
<div class='param-desc column is-7'>returns.data.kanban[].statusTagsList - List of status tags available for filtering</div>
|
|
988
|
+
|
|
989
|
+
|
|
990
|
+
<div class='column is-5 has-text-left'>
|
|
991
|
+
<label>Type: </label>
|
|
992
|
+
|
|
993
|
+
<code class="param-type">Array</code>
|
|
994
|
+
|
|
995
|
+
|
|
996
|
+
</div>
|
|
997
|
+
|
|
998
|
+
</div>
|
|
999
|
+
|
|
1000
|
+
|
|
1001
|
+
</div>
|
|
1002
|
+
</div>
|
|
1003
|
+
|
|
1004
|
+
|
|
1005
|
+
|
|
1006
|
+
|
|
1007
|
+
<h5>Example</h5>
|
|
1008
|
+
|
|
1009
|
+
|
|
1010
|
+
<pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
|
|
1011
|
+
const api = new API();
|
|
1012
|
+
const params = {
|
|
1013
|
+
orgId: '55e4a3bd6be6b45210833fae',
|
|
1014
|
+
orgProcessName: 'employee-onboarding',
|
|
1015
|
+
flowId: 'Task_16888el'
|
|
1016
|
+
};
|
|
1017
|
+
const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
1018
|
+
const kanbanData = await api.user.kanban.get(params, session);
|
|
1019
|
+
|
|
1020
|
+
Expected response structure:
|
|
1021
|
+
{
|
|
1022
|
+
success: true,
|
|
1023
|
+
kanban: [
|
|
1024
|
+
{
|
|
1025
|
+
id: 'pending',
|
|
1026
|
+
title: 'Pending Tasks',
|
|
1027
|
+
isExpanded: true,
|
|
1028
|
+
taskList: [
|
|
1029
|
+
{ taskId: '507f1f77bcf86cd799439011', title: 'Review Document', ... },
|
|
1030
|
+
{ taskId: '507f1f77bcf86cd799439012', title: 'Approve Request', ... }
|
|
1031
|
+
],
|
|
1032
|
+
statusTagsList: ['urgent', 'review', 'approved', 'rejected']
|
|
1033
|
+
},
|
|
1034
|
+
{
|
|
1035
|
+
id: 'in-progress',
|
|
1036
|
+
title: 'In Progress',
|
|
1037
|
+
isExpanded: true,
|
|
1038
|
+
taskList: [...],
|
|
1039
|
+
statusTagsList: ['urgent', 'review', 'approved', 'rejected']
|
|
1040
|
+
}
|
|
1041
|
+
]
|
|
1042
|
+
}</code></pre>
|
|
1043
|
+
|
|
1044
|
+
|
|
1045
|
+
|
|
1046
|
+
</div>
|
|
1047
|
+
|
|
1048
|
+
<div class="member">
|
|
1049
|
+
|
|
1050
|
+
|
|
1051
|
+
|
|
1052
|
+
<h4 class="name" id="removeTaskTag">
|
|
1053
|
+
<a class="href-link" href="#removeTaskTag">#</a>
|
|
1054
|
+
|
|
1055
|
+
|
|
1056
|
+
<span class='tag'>async</span>
|
|
1057
|
+
|
|
1058
|
+
|
|
1059
|
+
<span class="code-name">
|
|
1060
|
+
|
|
1061
|
+
removeTaskTag<span class="signature">(params, session)</span><span class="type-signature"> → {promise|Object|boolean|string}</span>
|
|
1062
|
+
|
|
1063
|
+
</span>
|
|
1064
|
+
</h4>
|
|
1065
|
+
|
|
1066
|
+
|
|
1067
|
+
|
|
1068
|
+
|
|
1069
|
+
<div class="description">
|
|
1070
|
+
Removes a specific tag from a task on the Kanban board
|
|
1071
|
+
</div>
|
|
1072
|
+
|
|
1073
|
+
|
|
1074
|
+
|
|
1075
|
+
|
|
1076
|
+
|
|
1077
|
+
|
|
1078
|
+
|
|
1079
|
+
|
|
1080
|
+
|
|
1081
|
+
|
|
1082
|
+
<h5>Parameters:</h5>
|
|
1083
|
+
|
|
1084
|
+
<div class="table-container">
|
|
1085
|
+
<table class="params table">
|
|
1086
|
+
<thead>
|
|
1087
|
+
<tr>
|
|
1088
|
+
|
|
1089
|
+
<th>Name</th>
|
|
1090
|
+
|
|
1091
|
+
|
|
1092
|
+
<th>Type</th>
|
|
1093
|
+
|
|
1094
|
+
|
|
1095
|
+
|
|
1096
|
+
|
|
1097
|
+
|
|
1098
|
+
<th class="last">Description</th>
|
|
1099
|
+
</tr>
|
|
1100
|
+
</thead>
|
|
1101
|
+
|
|
1102
|
+
<tbody>
|
|
1103
|
+
|
|
1104
|
+
|
|
1105
|
+
|
|
1106
|
+
<tr class="deep-level-0">
|
|
1107
|
+
|
|
1108
|
+
<td class="name"><code>params</code></td>
|
|
1109
|
+
|
|
1110
|
+
|
|
1111
|
+
<td class="type">
|
|
1112
|
+
|
|
1113
|
+
|
|
1114
|
+
<code class="param-type">Object</code>
|
|
1115
|
+
|
|
1116
|
+
|
|
1117
|
+
|
|
1118
|
+
</td>
|
|
1119
|
+
|
|
1120
|
+
|
|
1121
|
+
|
|
1122
|
+
|
|
1123
|
+
|
|
1124
|
+
<td class="description last">Parameters object</td>
|
|
1125
|
+
</tr>
|
|
1126
|
+
|
|
1127
|
+
|
|
1128
|
+
|
|
1129
|
+
|
|
1130
|
+
<tr class="deep-level-1">
|
|
1131
|
+
|
|
1132
|
+
<td class="name"><code>orgId</code></td>
|
|
1133
|
+
|
|
1134
|
+
|
|
1135
|
+
<td class="type">
|
|
1136
|
+
|
|
1137
|
+
|
|
1138
|
+
<code class="param-type">string</code>
|
|
1139
|
+
|
|
1140
|
+
|
|
1141
|
+
|
|
1142
|
+
</td>
|
|
1143
|
+
|
|
1144
|
+
|
|
1145
|
+
|
|
1146
|
+
|
|
1147
|
+
|
|
1148
|
+
<td class="description last">Organization id (_id database)</td>
|
|
1149
|
+
</tr>
|
|
1150
|
+
|
|
1151
|
+
|
|
1152
|
+
|
|
1153
|
+
<tr class="deep-level-1">
|
|
1154
|
+
|
|
1155
|
+
<td class="name"><code>taskId</code></td>
|
|
1156
|
+
|
|
1157
|
+
|
|
1158
|
+
<td class="type">
|
|
1159
|
+
|
|
1160
|
+
|
|
1161
|
+
<code class="param-type">string</code>
|
|
1162
|
+
|
|
1163
|
+
|
|
1164
|
+
|
|
1165
|
+
</td>
|
|
1166
|
+
|
|
1167
|
+
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
|
|
1171
|
+
<td class="description last">The ID of the task to update</td>
|
|
1172
|
+
</tr>
|
|
1173
|
+
|
|
1174
|
+
|
|
1175
|
+
|
|
1176
|
+
<tr class="deep-level-1">
|
|
1177
|
+
|
|
1178
|
+
<td class="name"><code>tag</code></td>
|
|
1179
|
+
|
|
1180
|
+
|
|
1181
|
+
<td class="type">
|
|
1182
|
+
|
|
1183
|
+
|
|
1184
|
+
<code class="param-type">string</code>
|
|
1185
|
+
|
|
1186
|
+
|
|
1187
|
+
|
|
1188
|
+
</td>
|
|
1189
|
+
|
|
1190
|
+
|
|
1191
|
+
|
|
1192
|
+
|
|
1193
|
+
|
|
1194
|
+
<td class="description last">The tag to remove from the task</td>
|
|
1195
|
+
</tr>
|
|
1196
|
+
|
|
1197
|
+
|
|
1198
|
+
|
|
1199
|
+
|
|
1200
|
+
|
|
1201
|
+
|
|
1202
|
+
|
|
1203
|
+
<tr class="deep-level-0">
|
|
1204
|
+
|
|
1205
|
+
<td class="name"><code>session</code></td>
|
|
1206
|
+
|
|
1207
|
+
|
|
1208
|
+
<td class="type">
|
|
1209
|
+
|
|
1210
|
+
|
|
1211
|
+
<code class="param-type">string</code>
|
|
1212
|
+
|
|
1213
|
+
|
|
1214
|
+
|
|
1215
|
+
</td>
|
|
1216
|
+
|
|
1217
|
+
|
|
1218
|
+
|
|
1219
|
+
|
|
1220
|
+
|
|
1221
|
+
<td class="description last">Session, token JWT</td>
|
|
1222
|
+
</tr>
|
|
1223
|
+
|
|
1224
|
+
|
|
1225
|
+
|
|
1226
|
+
</tbody>
|
|
1227
|
+
</table>
|
|
1228
|
+
</div>
|
|
1229
|
+
|
|
1230
|
+
|
|
1231
|
+
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
<dl class="details">
|
|
1235
|
+
|
|
1236
|
+
|
|
1237
|
+
|
|
1238
|
+
|
|
1239
|
+
|
|
1240
|
+
|
|
1241
|
+
|
|
1242
|
+
|
|
1243
|
+
|
|
1244
|
+
|
|
1245
|
+
|
|
1246
|
+
|
|
1247
|
+
|
|
1248
|
+
|
|
1249
|
+
|
|
1250
|
+
|
|
1251
|
+
|
|
1252
|
+
|
|
1253
|
+
<dt class="tag-author">Author:</dt>
|
|
1254
|
+
<dd class="tag-author">
|
|
1255
|
+
<ul>
|
|
1256
|
+
<li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
|
|
1257
|
+
</ul>
|
|
1258
|
+
</dd>
|
|
1259
|
+
|
|
1260
|
+
|
|
1261
|
+
|
|
1262
|
+
|
|
1263
|
+
|
|
1264
|
+
|
|
1265
|
+
|
|
1266
|
+
|
|
1267
|
+
|
|
1268
|
+
|
|
1269
|
+
|
|
1270
|
+
|
|
1271
|
+
|
|
1272
|
+
|
|
1273
|
+
<p class="tag-source">
|
|
1274
|
+
<a href="user_kanban.js.html" class="button">View Source</a>
|
|
1275
|
+
<span>
|
|
1276
|
+
<a href="user_kanban.js.html">user/kanban.js</a>, <a href="user_kanban.js.html#line411">line 411</a>
|
|
1277
|
+
</span>
|
|
1278
|
+
</p>
|
|
1279
|
+
|
|
1280
|
+
</dl>
|
|
1281
|
+
|
|
1282
|
+
|
|
1283
|
+
|
|
1284
|
+
|
|
1285
|
+
|
|
1286
|
+
|
|
1287
|
+
|
|
1288
|
+
|
|
1289
|
+
|
|
1290
|
+
|
|
1291
|
+
|
|
1292
|
+
|
|
1293
|
+
|
|
1294
|
+
|
|
1295
|
+
|
|
1296
|
+
|
|
1297
|
+
|
|
1298
|
+
|
|
1299
|
+
<div class='columns method-parameter'>
|
|
1300
|
+
<div class="column is-2"><label>Returns:</label></div>
|
|
1301
|
+
<div class="column is-10">
|
|
1302
|
+
|
|
1303
|
+
|
|
1304
|
+
|
|
1305
|
+
<div class="columns">
|
|
1306
|
+
|
|
1307
|
+
<div class='param-desc column is-7'>Promise that resolves to operation status</div>
|
|
1308
|
+
|
|
1309
|
+
|
|
1310
|
+
<div class='column is-5 has-text-left'>
|
|
1311
|
+
<label>Type: </label>
|
|
1312
|
+
|
|
1313
|
+
<code class="param-type">promise</code>
|
|
1314
|
+
|
|
1315
|
+
|
|
1316
|
+
</div>
|
|
1317
|
+
|
|
1318
|
+
</div>
|
|
1319
|
+
|
|
1320
|
+
|
|
1321
|
+
|
|
1322
|
+
|
|
1323
|
+
<div class="columns">
|
|
1324
|
+
|
|
1325
|
+
<div class='param-desc column is-7'>returns.data - The response data containing:</div>
|
|
1326
|
+
|
|
1327
|
+
|
|
1328
|
+
<div class='column is-5 has-text-left'>
|
|
1329
|
+
<label>Type: </label>
|
|
1330
|
+
|
|
1331
|
+
<code class="param-type">Object</code>
|
|
1332
|
+
|
|
1333
|
+
|
|
1334
|
+
</div>
|
|
1335
|
+
|
|
1336
|
+
</div>
|
|
1337
|
+
|
|
1338
|
+
|
|
1339
|
+
|
|
1340
|
+
|
|
1341
|
+
<div class="columns">
|
|
1342
|
+
|
|
1343
|
+
<div class='param-desc column is-7'>returns.data.success - Indicates if the operation was successful</div>
|
|
1344
|
+
|
|
1345
|
+
|
|
1346
|
+
<div class='column is-5 has-text-left'>
|
|
1347
|
+
<label>Type: </label>
|
|
1348
|
+
|
|
1349
|
+
<code class="param-type">boolean</code>
|
|
1350
|
+
|
|
1351
|
+
|
|
1352
|
+
</div>
|
|
1353
|
+
|
|
1354
|
+
</div>
|
|
1355
|
+
|
|
1356
|
+
|
|
1357
|
+
|
|
1358
|
+
|
|
1359
|
+
<div class="columns">
|
|
1360
|
+
|
|
1361
|
+
<div class='param-desc column is-7'>[returns.data.error] - Error message if operation failed</div>
|
|
1362
|
+
|
|
1363
|
+
|
|
1364
|
+
<div class='column is-5 has-text-left'>
|
|
1365
|
+
<label>Type: </label>
|
|
1366
|
+
|
|
1367
|
+
<code class="param-type">string</code>
|
|
1368
|
+
|
|
1369
|
+
|
|
1370
|
+
</div>
|
|
1371
|
+
|
|
1372
|
+
</div>
|
|
1373
|
+
|
|
1374
|
+
|
|
1375
|
+
</div>
|
|
1376
|
+
</div>
|
|
1377
|
+
|
|
1378
|
+
|
|
1379
|
+
|
|
1380
|
+
|
|
1381
|
+
<h5>Example</h5>
|
|
1382
|
+
|
|
1383
|
+
|
|
1384
|
+
<pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
|
|
1385
|
+
const api = new API();
|
|
1386
|
+
const params = {
|
|
1387
|
+
orgId: '55e4a3bd6be6b45210833fae',
|
|
1388
|
+
taskId: '507f1f77bcf86cd799439011',
|
|
1389
|
+
tag: 'urgent'
|
|
1390
|
+
};
|
|
1391
|
+
const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
1392
|
+
const result = await api.user.kanban.removeTaskTag(params, session);
|
|
1393
|
+
|
|
1394
|
+
Expected response structure (success):
|
|
1395
|
+
{
|
|
1396
|
+
success: true
|
|
1397
|
+
}
|
|
1398
|
+
|
|
1399
|
+
Expected response structure (error):
|
|
1400
|
+
{
|
|
1401
|
+
success: false,
|
|
1402
|
+
error: "Task not found"
|
|
1403
|
+
}</code></pre>
|
|
1404
|
+
|
|
1405
|
+
|
|
1406
|
+
|
|
1407
|
+
</div>
|
|
1408
|
+
|
|
1409
|
+
<div class="member">
|
|
1410
|
+
|
|
1411
|
+
|
|
1412
|
+
|
|
1413
|
+
<h4 class="name" id="updateStatusList">
|
|
1414
|
+
<a class="href-link" href="#updateStatusList">#</a>
|
|
1415
|
+
|
|
1416
|
+
|
|
1417
|
+
<span class='tag'>async</span>
|
|
1418
|
+
|
|
1419
|
+
|
|
1420
|
+
<span class="code-name">
|
|
1421
|
+
|
|
1422
|
+
updateStatusList<span class="signature">(params, session)</span><span class="type-signature"> → {promise|Object|boolean|string}</span>
|
|
1423
|
+
|
|
1424
|
+
</span>
|
|
1425
|
+
</h4>
|
|
1426
|
+
|
|
1427
|
+
|
|
1428
|
+
|
|
1429
|
+
|
|
1430
|
+
<div class="description">
|
|
1431
|
+
Updates the status list order for a specific flow in an organization process on the Kanban board
|
|
1432
|
+
Can also be used to update the name, expanded and or the color value of an status of the status list
|
|
1433
|
+
That is: updates the whole status list
|
|
1434
|
+
</div>
|
|
1435
|
+
|
|
1436
|
+
|
|
1437
|
+
|
|
1438
|
+
|
|
1439
|
+
|
|
1440
|
+
|
|
1441
|
+
|
|
1442
|
+
|
|
1443
|
+
|
|
1444
|
+
|
|
1445
|
+
<h5>Parameters:</h5>
|
|
1446
|
+
|
|
1447
|
+
<div class="table-container">
|
|
1448
|
+
<table class="params table">
|
|
1449
|
+
<thead>
|
|
1450
|
+
<tr>
|
|
1451
|
+
|
|
1452
|
+
<th>Name</th>
|
|
1453
|
+
|
|
1454
|
+
|
|
1455
|
+
<th>Type</th>
|
|
1456
|
+
|
|
1457
|
+
|
|
1458
|
+
|
|
1459
|
+
|
|
1460
|
+
|
|
1461
|
+
<th class="last">Description</th>
|
|
1462
|
+
</tr>
|
|
1463
|
+
</thead>
|
|
1464
|
+
|
|
1465
|
+
<tbody>
|
|
1466
|
+
|
|
1467
|
+
|
|
1468
|
+
|
|
1469
|
+
<tr class="deep-level-0">
|
|
1470
|
+
|
|
1471
|
+
<td class="name"><code>params</code></td>
|
|
1472
|
+
|
|
1473
|
+
|
|
1474
|
+
<td class="type">
|
|
1475
|
+
|
|
1476
|
+
|
|
1477
|
+
<code class="param-type">Object</code>
|
|
1478
|
+
|
|
1479
|
+
|
|
1480
|
+
|
|
1481
|
+
</td>
|
|
1482
|
+
|
|
1483
|
+
|
|
1484
|
+
|
|
1485
|
+
|
|
1486
|
+
|
|
1487
|
+
<td class="description last">Parameters object</td>
|
|
1488
|
+
</tr>
|
|
1489
|
+
|
|
1490
|
+
|
|
1491
|
+
|
|
1492
|
+
|
|
1493
|
+
<tr class="deep-level-1">
|
|
1494
|
+
|
|
1495
|
+
<td class="name"><code>orgId</code></td>
|
|
1496
|
+
|
|
1497
|
+
|
|
1498
|
+
<td class="type">
|
|
1499
|
+
|
|
1500
|
+
|
|
1501
|
+
<code class="param-type">string</code>
|
|
1502
|
+
|
|
1503
|
+
|
|
1504
|
+
|
|
1505
|
+
</td>
|
|
1506
|
+
|
|
1507
|
+
|
|
1508
|
+
|
|
1509
|
+
|
|
1510
|
+
|
|
1511
|
+
<td class="description last">Organization id (_id database)</td>
|
|
1512
|
+
</tr>
|
|
1513
|
+
|
|
1514
|
+
|
|
1515
|
+
|
|
1516
|
+
<tr class="deep-level-1">
|
|
1517
|
+
|
|
1518
|
+
<td class="name"><code>orgProcessName</code></td>
|
|
1519
|
+
|
|
1520
|
+
|
|
1521
|
+
<td class="type">
|
|
1522
|
+
|
|
1523
|
+
|
|
1524
|
+
<code class="param-type">string</code>
|
|
1525
|
+
|
|
1526
|
+
|
|
1527
|
+
|
|
1528
|
+
</td>
|
|
1529
|
+
|
|
1530
|
+
|
|
1531
|
+
|
|
1532
|
+
|
|
1533
|
+
|
|
1534
|
+
<td class="description last">The name of the organization process</td>
|
|
1535
|
+
</tr>
|
|
1536
|
+
|
|
1537
|
+
|
|
1538
|
+
|
|
1539
|
+
<tr class="deep-level-1">
|
|
1540
|
+
|
|
1541
|
+
<td class="name"><code>flowName</code></td>
|
|
1542
|
+
|
|
1543
|
+
|
|
1544
|
+
<td class="type">
|
|
1545
|
+
|
|
1546
|
+
|
|
1547
|
+
<code class="param-type">string</code>
|
|
1548
|
+
|
|
1549
|
+
|
|
1550
|
+
|
|
1551
|
+
</td>
|
|
1552
|
+
|
|
1553
|
+
|
|
1554
|
+
|
|
1555
|
+
|
|
1556
|
+
|
|
1557
|
+
<td class="description last">The name of the organization process step flowName</td>
|
|
1558
|
+
</tr>
|
|
1559
|
+
|
|
1560
|
+
|
|
1561
|
+
|
|
1562
|
+
<tr class="deep-level-1">
|
|
1563
|
+
|
|
1564
|
+
<td class="name"><code>statusList</code></td>
|
|
1565
|
+
|
|
1566
|
+
|
|
1567
|
+
<td class="type">
|
|
1568
|
+
|
|
1569
|
+
|
|
1570
|
+
<code class="param-type">Array</code>
|
|
1571
|
+
|
|
1572
|
+
|
|
1573
|
+
|
|
1574
|
+
</td>
|
|
1575
|
+
|
|
1576
|
+
|
|
1577
|
+
|
|
1578
|
+
|
|
1579
|
+
|
|
1580
|
+
<td class="description last">The status list with new order</td>
|
|
1581
|
+
</tr>
|
|
1582
|
+
|
|
1583
|
+
|
|
1584
|
+
|
|
1585
|
+
<tr class="deep-level-1">
|
|
1586
|
+
|
|
1587
|
+
<td class="name"><code>statusList[</code></td>
|
|
1588
|
+
|
|
1589
|
+
|
|
1590
|
+
<td class="type">
|
|
1591
|
+
|
|
1592
|
+
|
|
1593
|
+
<code class="param-type">Object</code>
|
|
1594
|
+
|
|
1595
|
+
|
|
1596
|
+
|
|
1597
|
+
</td>
|
|
1598
|
+
|
|
1599
|
+
|
|
1600
|
+
|
|
1601
|
+
|
|
1602
|
+
|
|
1603
|
+
<td class="description last">Status object configuration</td>
|
|
1604
|
+
</tr>
|
|
1605
|
+
|
|
1606
|
+
|
|
1607
|
+
|
|
1608
|
+
<tr class="deep-level-1">
|
|
1609
|
+
|
|
1610
|
+
<td class="name"><code>statusList[].value</code></td>
|
|
1611
|
+
|
|
1612
|
+
|
|
1613
|
+
<td class="type">
|
|
1614
|
+
|
|
1615
|
+
|
|
1616
|
+
<code class="param-type">string</code>
|
|
1617
|
+
|
|
1618
|
+
|
|
1619
|
+
|
|
1620
|
+
</td>
|
|
1621
|
+
|
|
1622
|
+
|
|
1623
|
+
|
|
1624
|
+
|
|
1625
|
+
|
|
1626
|
+
<td class="description last">The title of the status</td>
|
|
1627
|
+
</tr>
|
|
1628
|
+
|
|
1629
|
+
|
|
1630
|
+
|
|
1631
|
+
<tr class="deep-level-1">
|
|
1632
|
+
|
|
1633
|
+
<td class="name"><code>statusList[].expanded</code></td>
|
|
1634
|
+
|
|
1635
|
+
|
|
1636
|
+
<td class="type">
|
|
1637
|
+
|
|
1638
|
+
|
|
1639
|
+
<code class="param-type">boolean</code>
|
|
1640
|
+
|
|
1641
|
+
|
|
1642
|
+
|
|
1643
|
+
</td>
|
|
1644
|
+
|
|
1645
|
+
|
|
1646
|
+
|
|
1647
|
+
|
|
1648
|
+
|
|
1649
|
+
<td class="description last">If the status column is expanded or not</td>
|
|
1650
|
+
</tr>
|
|
1651
|
+
|
|
1652
|
+
|
|
1653
|
+
|
|
1654
|
+
<tr class="deep-level-1">
|
|
1655
|
+
|
|
1656
|
+
<td class="name"><code>statusList[].color</code></td>
|
|
1657
|
+
|
|
1658
|
+
|
|
1659
|
+
<td class="type">
|
|
1660
|
+
|
|
1661
|
+
|
|
1662
|
+
<code class="param-type">string</code>
|
|
1663
|
+
|
|
1664
|
+
|
|
1665
|
+
|
|
1666
|
+
</td>
|
|
1667
|
+
|
|
1668
|
+
|
|
1669
|
+
|
|
1670
|
+
|
|
1671
|
+
|
|
1672
|
+
<td class="description last">The hexadecimal color code for the status</td>
|
|
1673
|
+
</tr>
|
|
1674
|
+
|
|
1675
|
+
|
|
1676
|
+
|
|
1677
|
+
|
|
1678
|
+
|
|
1679
|
+
|
|
1680
|
+
|
|
1681
|
+
<tr class="deep-level-0">
|
|
1682
|
+
|
|
1683
|
+
<td class="name"><code>session</code></td>
|
|
1684
|
+
|
|
1685
|
+
|
|
1686
|
+
<td class="type">
|
|
1687
|
+
|
|
1688
|
+
|
|
1689
|
+
<code class="param-type">string</code>
|
|
1690
|
+
|
|
1691
|
+
|
|
1692
|
+
|
|
1693
|
+
</td>
|
|
1694
|
+
|
|
1695
|
+
|
|
1696
|
+
|
|
1697
|
+
|
|
1698
|
+
|
|
1699
|
+
<td class="description last">Session, token JWT</td>
|
|
1700
|
+
</tr>
|
|
1701
|
+
|
|
1702
|
+
|
|
1703
|
+
|
|
1704
|
+
</tbody>
|
|
1705
|
+
</table>
|
|
1706
|
+
</div>
|
|
1707
|
+
|
|
1708
|
+
|
|
1709
|
+
|
|
1710
|
+
|
|
1711
|
+
|
|
1712
|
+
<dl class="details">
|
|
1713
|
+
|
|
1714
|
+
|
|
1715
|
+
|
|
1716
|
+
|
|
1717
|
+
|
|
1718
|
+
|
|
1719
|
+
|
|
1720
|
+
|
|
1721
|
+
|
|
1722
|
+
|
|
1723
|
+
|
|
1724
|
+
|
|
1725
|
+
|
|
1726
|
+
|
|
1727
|
+
|
|
1728
|
+
|
|
1729
|
+
|
|
1730
|
+
|
|
1731
|
+
<dt class="tag-author">Author:</dt>
|
|
1732
|
+
<dd class="tag-author">
|
|
1733
|
+
<ul>
|
|
1734
|
+
<li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
|
|
1735
|
+
</ul>
|
|
1736
|
+
</dd>
|
|
1737
|
+
|
|
1738
|
+
|
|
1739
|
+
|
|
1740
|
+
|
|
1741
|
+
|
|
1742
|
+
|
|
1743
|
+
|
|
1744
|
+
|
|
1745
|
+
|
|
1746
|
+
|
|
1747
|
+
|
|
1748
|
+
|
|
1749
|
+
|
|
1750
|
+
|
|
1751
|
+
<p class="tag-source">
|
|
1752
|
+
<a href="user_kanban.js.html" class="button">View Source</a>
|
|
1753
|
+
<span>
|
|
1754
|
+
<a href="user_kanban.js.html">user/kanban.js</a>, <a href="user_kanban.js.html#line484">line 484</a>
|
|
1755
|
+
</span>
|
|
1756
|
+
</p>
|
|
1757
|
+
|
|
1758
|
+
</dl>
|
|
1759
|
+
|
|
1760
|
+
|
|
1761
|
+
|
|
1762
|
+
|
|
1763
|
+
|
|
1764
|
+
|
|
1765
|
+
|
|
1766
|
+
|
|
1767
|
+
|
|
1768
|
+
|
|
1769
|
+
|
|
1770
|
+
|
|
1771
|
+
|
|
1772
|
+
|
|
1773
|
+
|
|
1774
|
+
|
|
1775
|
+
|
|
1776
|
+
|
|
1777
|
+
<div class='columns method-parameter'>
|
|
1778
|
+
<div class="column is-2"><label>Returns:</label></div>
|
|
1779
|
+
<div class="column is-10">
|
|
1780
|
+
|
|
1781
|
+
|
|
1782
|
+
|
|
1783
|
+
<div class="columns">
|
|
1784
|
+
|
|
1785
|
+
<div class='param-desc column is-7'>Promise that resolves to operation status</div>
|
|
1786
|
+
|
|
1787
|
+
|
|
1788
|
+
<div class='column is-5 has-text-left'>
|
|
1789
|
+
<label>Type: </label>
|
|
1790
|
+
|
|
1791
|
+
<code class="param-type">promise</code>
|
|
1792
|
+
|
|
1793
|
+
|
|
1794
|
+
</div>
|
|
1795
|
+
|
|
1796
|
+
</div>
|
|
1797
|
+
|
|
1798
|
+
|
|
1799
|
+
|
|
1800
|
+
|
|
1801
|
+
<div class="columns">
|
|
1802
|
+
|
|
1803
|
+
<div class='param-desc column is-7'>returns.data - The response data containing:</div>
|
|
1804
|
+
|
|
1805
|
+
|
|
1806
|
+
<div class='column is-5 has-text-left'>
|
|
1807
|
+
<label>Type: </label>
|
|
1808
|
+
|
|
1809
|
+
<code class="param-type">Object</code>
|
|
1810
|
+
|
|
1811
|
+
|
|
1812
|
+
</div>
|
|
1813
|
+
|
|
1814
|
+
</div>
|
|
1815
|
+
|
|
1816
|
+
|
|
1817
|
+
|
|
1818
|
+
|
|
1819
|
+
<div class="columns">
|
|
1820
|
+
|
|
1821
|
+
<div class='param-desc column is-7'>returns.data.success - Indicates if the operation was successful</div>
|
|
1822
|
+
|
|
1823
|
+
|
|
1824
|
+
<div class='column is-5 has-text-left'>
|
|
1825
|
+
<label>Type: </label>
|
|
1826
|
+
|
|
1827
|
+
<code class="param-type">boolean</code>
|
|
1828
|
+
|
|
1829
|
+
|
|
1830
|
+
</div>
|
|
1831
|
+
|
|
1832
|
+
</div>
|
|
1833
|
+
|
|
1834
|
+
|
|
1835
|
+
|
|
1836
|
+
|
|
1837
|
+
<div class="columns">
|
|
1838
|
+
|
|
1839
|
+
<div class='param-desc column is-7'>[returns.data.error] - Error message if operation failed</div>
|
|
1840
|
+
|
|
1841
|
+
|
|
1842
|
+
<div class='column is-5 has-text-left'>
|
|
1843
|
+
<label>Type: </label>
|
|
1844
|
+
|
|
1845
|
+
<code class="param-type">string</code>
|
|
1846
|
+
|
|
1847
|
+
|
|
1848
|
+
</div>
|
|
1849
|
+
|
|
1850
|
+
</div>
|
|
1851
|
+
|
|
1852
|
+
|
|
1853
|
+
</div>
|
|
1854
|
+
</div>
|
|
1855
|
+
|
|
1856
|
+
|
|
1857
|
+
|
|
1858
|
+
|
|
1859
|
+
<h5>Example</h5>
|
|
1860
|
+
|
|
1861
|
+
|
|
1862
|
+
<pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
|
|
1863
|
+
const api = new API();
|
|
1864
|
+
const params = {
|
|
1865
|
+
orgId: '55e4a3bd6be6b45210833fae',
|
|
1866
|
+
orgProcessName: 'employee-onboarding',
|
|
1867
|
+
flowName: 'approval-flow',
|
|
1868
|
+
statusList: [
|
|
1869
|
+
{ value: 'Pending', expanded: true, color: '#FF6B6B' },
|
|
1870
|
+
{ value: 'In Progress', expanded: true, color: '#4ECDC4' },
|
|
1871
|
+
{ value: 'Under Review', expanded: false, color: '#45B7D1' },
|
|
1872
|
+
{ value: 'Completed', expanded: true, color: '#96CEB4' }
|
|
1873
|
+
]
|
|
1874
|
+
};
|
|
1875
|
+
const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
1876
|
+
const result = await api.user.kanban.updateStatusList(params, session);
|
|
1877
|
+
|
|
1878
|
+
Expected response structure (success):
|
|
1879
|
+
{
|
|
1880
|
+
success: true
|
|
1881
|
+
}
|
|
1882
|
+
|
|
1883
|
+
Expected response structure (error):
|
|
1884
|
+
{
|
|
1885
|
+
success: false,
|
|
1886
|
+
error: "Organization process not found"
|
|
1887
|
+
}</code></pre>
|
|
1888
|
+
|
|
1889
|
+
|
|
1890
|
+
|
|
1891
|
+
</div>
|
|
1892
|
+
|
|
1893
|
+
<div class="member">
|
|
1894
|
+
|
|
1895
|
+
|
|
1896
|
+
|
|
1897
|
+
<h4 class="name" id="updateTaskOrder">
|
|
1898
|
+
<a class="href-link" href="#updateTaskOrder">#</a>
|
|
1899
|
+
|
|
1900
|
+
|
|
1901
|
+
<span class='tag'>async</span>
|
|
1902
|
+
|
|
1903
|
+
|
|
1904
|
+
<span class="code-name">
|
|
1905
|
+
|
|
1906
|
+
updateTaskOrder<span class="signature">(params, session)</span><span class="type-signature"> → {promise|Object|boolean|string}</span>
|
|
1907
|
+
|
|
1908
|
+
</span>
|
|
1909
|
+
</h4>
|
|
1910
|
+
|
|
1911
|
+
|
|
1912
|
+
|
|
1913
|
+
|
|
1914
|
+
<div class="description">
|
|
1915
|
+
Updates the order of a task in its status column on the Kanban board
|
|
1916
|
+
</div>
|
|
1917
|
+
|
|
1918
|
+
|
|
1919
|
+
|
|
1920
|
+
|
|
1921
|
+
|
|
1922
|
+
|
|
1923
|
+
|
|
1924
|
+
|
|
1925
|
+
|
|
1926
|
+
|
|
1927
|
+
<h5>Parameters:</h5>
|
|
1928
|
+
|
|
1929
|
+
<div class="table-container">
|
|
1930
|
+
<table class="params table">
|
|
1931
|
+
<thead>
|
|
1932
|
+
<tr>
|
|
1933
|
+
|
|
1934
|
+
<th>Name</th>
|
|
1935
|
+
|
|
1936
|
+
|
|
1937
|
+
<th>Type</th>
|
|
1938
|
+
|
|
1939
|
+
|
|
1940
|
+
|
|
1941
|
+
|
|
1942
|
+
|
|
1943
|
+
<th class="last">Description</th>
|
|
1944
|
+
</tr>
|
|
1945
|
+
</thead>
|
|
1946
|
+
|
|
1947
|
+
<tbody>
|
|
1948
|
+
|
|
1949
|
+
|
|
1950
|
+
|
|
1951
|
+
<tr class="deep-level-0">
|
|
1952
|
+
|
|
1953
|
+
<td class="name"><code>params</code></td>
|
|
1954
|
+
|
|
1955
|
+
|
|
1956
|
+
<td class="type">
|
|
1957
|
+
|
|
1958
|
+
|
|
1959
|
+
<code class="param-type">Object</code>
|
|
1960
|
+
|
|
1961
|
+
|
|
1962
|
+
|
|
1963
|
+
</td>
|
|
1964
|
+
|
|
1965
|
+
|
|
1966
|
+
|
|
1967
|
+
|
|
1968
|
+
|
|
1969
|
+
<td class="description last">Parameters object</td>
|
|
1970
|
+
</tr>
|
|
1971
|
+
|
|
1972
|
+
|
|
1973
|
+
|
|
1974
|
+
|
|
1975
|
+
<tr class="deep-level-1">
|
|
1976
|
+
|
|
1977
|
+
<td class="name"><code>orgId</code></td>
|
|
1978
|
+
|
|
1979
|
+
|
|
1980
|
+
<td class="type">
|
|
1981
|
+
|
|
1982
|
+
|
|
1983
|
+
<code class="param-type">string</code>
|
|
1984
|
+
|
|
1985
|
+
|
|
1986
|
+
|
|
1987
|
+
</td>
|
|
1988
|
+
|
|
1989
|
+
|
|
1990
|
+
|
|
1991
|
+
|
|
1992
|
+
|
|
1993
|
+
<td class="description last">Organization id (_id database)</td>
|
|
1994
|
+
</tr>
|
|
1995
|
+
|
|
1996
|
+
|
|
1997
|
+
|
|
1998
|
+
<tr class="deep-level-1">
|
|
1999
|
+
|
|
2000
|
+
<td class="name"><code>taskId</code></td>
|
|
2001
|
+
|
|
2002
|
+
|
|
2003
|
+
<td class="type">
|
|
2004
|
+
|
|
2005
|
+
|
|
2006
|
+
<code class="param-type">string</code>
|
|
2007
|
+
|
|
2008
|
+
|
|
2009
|
+
|
|
2010
|
+
</td>
|
|
2011
|
+
|
|
2012
|
+
|
|
2013
|
+
|
|
2014
|
+
|
|
2015
|
+
|
|
2016
|
+
<td class="description last">The ID of the task to update</td>
|
|
2017
|
+
</tr>
|
|
2018
|
+
|
|
2019
|
+
|
|
2020
|
+
|
|
2021
|
+
<tr class="deep-level-1">
|
|
2022
|
+
|
|
2023
|
+
<td class="name"><code>order</code></td>
|
|
2024
|
+
|
|
2025
|
+
|
|
2026
|
+
<td class="type">
|
|
2027
|
+
|
|
2028
|
+
|
|
2029
|
+
<code class="param-type">number</code>
|
|
2030
|
+
|
|
2031
|
+
|
|
2032
|
+
|
|
2033
|
+
</td>
|
|
2034
|
+
|
|
2035
|
+
|
|
2036
|
+
|
|
2037
|
+
|
|
2038
|
+
|
|
2039
|
+
<td class="description last">The new order position of the task</td>
|
|
2040
|
+
</tr>
|
|
2041
|
+
|
|
2042
|
+
|
|
2043
|
+
|
|
2044
|
+
|
|
2045
|
+
|
|
2046
|
+
|
|
2047
|
+
|
|
2048
|
+
<tr class="deep-level-0">
|
|
2049
|
+
|
|
2050
|
+
<td class="name"><code>session</code></td>
|
|
2051
|
+
|
|
2052
|
+
|
|
2053
|
+
<td class="type">
|
|
2054
|
+
|
|
2055
|
+
|
|
2056
|
+
<code class="param-type">string</code>
|
|
2057
|
+
|
|
2058
|
+
|
|
2059
|
+
|
|
2060
|
+
</td>
|
|
2061
|
+
|
|
2062
|
+
|
|
2063
|
+
|
|
2064
|
+
|
|
2065
|
+
|
|
2066
|
+
<td class="description last">Session, token JWT</td>
|
|
2067
|
+
</tr>
|
|
2068
|
+
|
|
2069
|
+
|
|
2070
|
+
|
|
2071
|
+
</tbody>
|
|
2072
|
+
</table>
|
|
2073
|
+
</div>
|
|
2074
|
+
|
|
2075
|
+
|
|
2076
|
+
|
|
2077
|
+
|
|
2078
|
+
|
|
2079
|
+
<dl class="details">
|
|
2080
|
+
|
|
2081
|
+
|
|
2082
|
+
|
|
2083
|
+
|
|
2084
|
+
|
|
2085
|
+
|
|
2086
|
+
|
|
2087
|
+
|
|
2088
|
+
|
|
2089
|
+
|
|
2090
|
+
|
|
2091
|
+
|
|
2092
|
+
|
|
2093
|
+
|
|
2094
|
+
|
|
2095
|
+
|
|
2096
|
+
|
|
2097
|
+
|
|
2098
|
+
<dt class="tag-author">Author:</dt>
|
|
2099
|
+
<dd class="tag-author">
|
|
2100
|
+
<ul>
|
|
2101
|
+
<li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
|
|
2102
|
+
</ul>
|
|
2103
|
+
</dd>
|
|
2104
|
+
|
|
2105
|
+
|
|
2106
|
+
|
|
2107
|
+
|
|
2108
|
+
|
|
2109
|
+
|
|
2110
|
+
|
|
2111
|
+
|
|
2112
|
+
|
|
2113
|
+
|
|
2114
|
+
|
|
2115
|
+
|
|
2116
|
+
|
|
2117
|
+
|
|
2118
|
+
<p class="tag-source">
|
|
2119
|
+
<a href="user_kanban.js.html" class="button">View Source</a>
|
|
2120
|
+
<span>
|
|
2121
|
+
<a href="user_kanban.js.html">user/kanban.js</a>, <a href="user_kanban.js.html#line168">line 168</a>
|
|
2122
|
+
</span>
|
|
2123
|
+
</p>
|
|
2124
|
+
|
|
2125
|
+
</dl>
|
|
2126
|
+
|
|
2127
|
+
|
|
2128
|
+
|
|
2129
|
+
|
|
2130
|
+
|
|
2131
|
+
|
|
2132
|
+
|
|
2133
|
+
|
|
2134
|
+
|
|
2135
|
+
|
|
2136
|
+
|
|
2137
|
+
|
|
2138
|
+
|
|
2139
|
+
|
|
2140
|
+
|
|
2141
|
+
|
|
2142
|
+
|
|
2143
|
+
|
|
2144
|
+
<div class='columns method-parameter'>
|
|
2145
|
+
<div class="column is-2"><label>Returns:</label></div>
|
|
2146
|
+
<div class="column is-10">
|
|
2147
|
+
|
|
2148
|
+
|
|
2149
|
+
|
|
2150
|
+
<div class="columns">
|
|
2151
|
+
|
|
2152
|
+
<div class='param-desc column is-7'>Promise that resolves to operation status</div>
|
|
2153
|
+
|
|
2154
|
+
|
|
2155
|
+
<div class='column is-5 has-text-left'>
|
|
2156
|
+
<label>Type: </label>
|
|
2157
|
+
|
|
2158
|
+
<code class="param-type">promise</code>
|
|
2159
|
+
|
|
2160
|
+
|
|
2161
|
+
</div>
|
|
2162
|
+
|
|
2163
|
+
</div>
|
|
2164
|
+
|
|
2165
|
+
|
|
2166
|
+
|
|
2167
|
+
|
|
2168
|
+
<div class="columns">
|
|
2169
|
+
|
|
2170
|
+
<div class='param-desc column is-7'>returns.data - The response data containing:</div>
|
|
2171
|
+
|
|
2172
|
+
|
|
2173
|
+
<div class='column is-5 has-text-left'>
|
|
2174
|
+
<label>Type: </label>
|
|
2175
|
+
|
|
2176
|
+
<code class="param-type">Object</code>
|
|
2177
|
+
|
|
2178
|
+
|
|
2179
|
+
</div>
|
|
2180
|
+
|
|
2181
|
+
</div>
|
|
2182
|
+
|
|
2183
|
+
|
|
2184
|
+
|
|
2185
|
+
|
|
2186
|
+
<div class="columns">
|
|
2187
|
+
|
|
2188
|
+
<div class='param-desc column is-7'>returns.data.success - Indicates if the operation was successful</div>
|
|
2189
|
+
|
|
2190
|
+
|
|
2191
|
+
<div class='column is-5 has-text-left'>
|
|
2192
|
+
<label>Type: </label>
|
|
2193
|
+
|
|
2194
|
+
<code class="param-type">boolean</code>
|
|
2195
|
+
|
|
2196
|
+
|
|
2197
|
+
</div>
|
|
2198
|
+
|
|
2199
|
+
</div>
|
|
2200
|
+
|
|
2201
|
+
|
|
2202
|
+
|
|
2203
|
+
|
|
2204
|
+
<div class="columns">
|
|
2205
|
+
|
|
2206
|
+
<div class='param-desc column is-7'>[returns.data.error] - Error message if operation failed</div>
|
|
2207
|
+
|
|
2208
|
+
|
|
2209
|
+
<div class='column is-5 has-text-left'>
|
|
2210
|
+
<label>Type: </label>
|
|
2211
|
+
|
|
2212
|
+
<code class="param-type">string</code>
|
|
2213
|
+
|
|
2214
|
+
|
|
2215
|
+
</div>
|
|
2216
|
+
|
|
2217
|
+
</div>
|
|
2218
|
+
|
|
2219
|
+
|
|
2220
|
+
</div>
|
|
2221
|
+
</div>
|
|
2222
|
+
|
|
2223
|
+
|
|
2224
|
+
|
|
2225
|
+
|
|
2226
|
+
<h5>Example</h5>
|
|
2227
|
+
|
|
2228
|
+
|
|
2229
|
+
<pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
|
|
2230
|
+
const api = new API();
|
|
2231
|
+
const params = {
|
|
2232
|
+
orgId: '55e4a3bd6be6b45210833fae',
|
|
2233
|
+
taskId: '507f1f77bcf86cd799439011',
|
|
2234
|
+
order: 3
|
|
2235
|
+
};
|
|
2236
|
+
const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
2237
|
+
const result = await api.user.kanban.updateTaskOrder(params, session);
|
|
2238
|
+
|
|
2239
|
+
Expected response structure (success):
|
|
2240
|
+
{
|
|
2241
|
+
success: true
|
|
2242
|
+
}
|
|
2243
|
+
|
|
2244
|
+
Expected response structure (error):
|
|
2245
|
+
{
|
|
2246
|
+
success: false,
|
|
2247
|
+
error: "Task not found"
|
|
2248
|
+
}</code></pre>
|
|
2249
|
+
|
|
2250
|
+
|
|
2251
|
+
|
|
2252
|
+
</div>
|
|
2253
|
+
|
|
2254
|
+
<div class="member">
|
|
2255
|
+
|
|
2256
|
+
|
|
2257
|
+
|
|
2258
|
+
<h4 class="name" id="updateTaskStatus">
|
|
2259
|
+
<a class="href-link" href="#updateTaskStatus">#</a>
|
|
2260
|
+
|
|
2261
|
+
|
|
2262
|
+
<span class='tag'>async</span>
|
|
2263
|
+
|
|
2264
|
+
|
|
2265
|
+
<span class="code-name">
|
|
2266
|
+
|
|
2267
|
+
updateTaskStatus<span class="signature">(params, session)</span><span class="type-signature"> → {promise|Object|boolean|string}</span>
|
|
2268
|
+
|
|
2269
|
+
</span>
|
|
2270
|
+
</h4>
|
|
2271
|
+
|
|
2272
|
+
|
|
2273
|
+
|
|
2274
|
+
|
|
2275
|
+
<div class="description">
|
|
2276
|
+
Updates the status of a task on the Kanban board when moved between columns
|
|
2277
|
+
</div>
|
|
2278
|
+
|
|
2279
|
+
|
|
2280
|
+
|
|
2281
|
+
|
|
2282
|
+
|
|
2283
|
+
|
|
2284
|
+
|
|
2285
|
+
|
|
2286
|
+
|
|
2287
|
+
|
|
2288
|
+
<h5>Parameters:</h5>
|
|
2289
|
+
|
|
2290
|
+
<div class="table-container">
|
|
2291
|
+
<table class="params table">
|
|
2292
|
+
<thead>
|
|
2293
|
+
<tr>
|
|
2294
|
+
|
|
2295
|
+
<th>Name</th>
|
|
2296
|
+
|
|
2297
|
+
|
|
2298
|
+
<th>Type</th>
|
|
2299
|
+
|
|
2300
|
+
|
|
2301
|
+
|
|
2302
|
+
|
|
2303
|
+
|
|
2304
|
+
<th class="last">Description</th>
|
|
2305
|
+
</tr>
|
|
2306
|
+
</thead>
|
|
2307
|
+
|
|
2308
|
+
<tbody>
|
|
2309
|
+
|
|
2310
|
+
|
|
2311
|
+
|
|
2312
|
+
<tr class="deep-level-0">
|
|
2313
|
+
|
|
2314
|
+
<td class="name"><code>params</code></td>
|
|
2315
|
+
|
|
2316
|
+
|
|
2317
|
+
<td class="type">
|
|
2318
|
+
|
|
2319
|
+
|
|
2320
|
+
<code class="param-type">Object</code>
|
|
2321
|
+
|
|
2322
|
+
|
|
2323
|
+
|
|
2324
|
+
</td>
|
|
2325
|
+
|
|
2326
|
+
|
|
2327
|
+
|
|
2328
|
+
|
|
2329
|
+
|
|
2330
|
+
<td class="description last">Parameters object</td>
|
|
2331
|
+
</tr>
|
|
2332
|
+
|
|
2333
|
+
|
|
2334
|
+
|
|
2335
|
+
|
|
2336
|
+
<tr class="deep-level-1">
|
|
2337
|
+
|
|
2338
|
+
<td class="name"><code>orgId</code></td>
|
|
2339
|
+
|
|
2340
|
+
|
|
2341
|
+
<td class="type">
|
|
2342
|
+
|
|
2343
|
+
|
|
2344
|
+
<code class="param-type">string</code>
|
|
2345
|
+
|
|
2346
|
+
|
|
2347
|
+
|
|
2348
|
+
</td>
|
|
2349
|
+
|
|
2350
|
+
|
|
2351
|
+
|
|
2352
|
+
|
|
2353
|
+
|
|
2354
|
+
<td class="description last">Organization id (_id database)</td>
|
|
2355
|
+
</tr>
|
|
2356
|
+
|
|
2357
|
+
|
|
2358
|
+
|
|
2359
|
+
<tr class="deep-level-1">
|
|
2360
|
+
|
|
2361
|
+
<td class="name"><code>taskId</code></td>
|
|
2362
|
+
|
|
2363
|
+
|
|
2364
|
+
<td class="type">
|
|
2365
|
+
|
|
2366
|
+
|
|
2367
|
+
<code class="param-type">string</code>
|
|
2368
|
+
|
|
2369
|
+
|
|
2370
|
+
|
|
2371
|
+
</td>
|
|
2372
|
+
|
|
2373
|
+
|
|
2374
|
+
|
|
2375
|
+
|
|
2376
|
+
|
|
2377
|
+
<td class="description last">The ID of the task to update</td>
|
|
2378
|
+
</tr>
|
|
2379
|
+
|
|
2380
|
+
|
|
2381
|
+
|
|
2382
|
+
<tr class="deep-level-1">
|
|
2383
|
+
|
|
2384
|
+
<td class="name"><code>status</code></td>
|
|
2385
|
+
|
|
2386
|
+
|
|
2387
|
+
<td class="type">
|
|
2388
|
+
|
|
2389
|
+
|
|
2390
|
+
<code class="param-type">string</code>
|
|
2391
|
+
|
|
2392
|
+
|
|
2393
|
+
|
|
2394
|
+
</td>
|
|
2395
|
+
|
|
2396
|
+
|
|
2397
|
+
|
|
2398
|
+
|
|
2399
|
+
|
|
2400
|
+
<td class="description last">The new status value for the task</td>
|
|
2401
|
+
</tr>
|
|
2402
|
+
|
|
2403
|
+
|
|
2404
|
+
|
|
2405
|
+
|
|
2406
|
+
|
|
2407
|
+
|
|
2408
|
+
|
|
2409
|
+
<tr class="deep-level-0">
|
|
2410
|
+
|
|
2411
|
+
<td class="name"><code>session</code></td>
|
|
2412
|
+
|
|
2413
|
+
|
|
2414
|
+
<td class="type">
|
|
2415
|
+
|
|
2416
|
+
|
|
2417
|
+
<code class="param-type">string</code>
|
|
2418
|
+
|
|
2419
|
+
|
|
2420
|
+
|
|
2421
|
+
</td>
|
|
2422
|
+
|
|
2423
|
+
|
|
2424
|
+
|
|
2425
|
+
|
|
2426
|
+
|
|
2427
|
+
<td class="description last">Session, token JWT</td>
|
|
2428
|
+
</tr>
|
|
2429
|
+
|
|
2430
|
+
|
|
2431
|
+
|
|
2432
|
+
</tbody>
|
|
2433
|
+
</table>
|
|
2434
|
+
</div>
|
|
2435
|
+
|
|
2436
|
+
|
|
2437
|
+
|
|
2438
|
+
|
|
2439
|
+
|
|
2440
|
+
<dl class="details">
|
|
2441
|
+
|
|
2442
|
+
|
|
2443
|
+
|
|
2444
|
+
|
|
2445
|
+
|
|
2446
|
+
|
|
2447
|
+
|
|
2448
|
+
|
|
2449
|
+
|
|
2450
|
+
|
|
2451
|
+
|
|
2452
|
+
|
|
2453
|
+
|
|
2454
|
+
|
|
2455
|
+
|
|
2456
|
+
|
|
2457
|
+
|
|
2458
|
+
|
|
2459
|
+
<dt class="tag-author">Author:</dt>
|
|
2460
|
+
<dd class="tag-author">
|
|
2461
|
+
<ul>
|
|
2462
|
+
<li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
|
|
2463
|
+
</ul>
|
|
2464
|
+
</dd>
|
|
2465
|
+
|
|
2466
|
+
|
|
2467
|
+
|
|
2468
|
+
|
|
2469
|
+
|
|
2470
|
+
|
|
2471
|
+
|
|
2472
|
+
|
|
2473
|
+
|
|
2474
|
+
|
|
2475
|
+
|
|
2476
|
+
|
|
2477
|
+
|
|
2478
|
+
|
|
2479
|
+
<p class="tag-source">
|
|
2480
|
+
<a href="user_kanban.js.html" class="button">View Source</a>
|
|
2481
|
+
<span>
|
|
2482
|
+
<a href="user_kanban.js.html">user/kanban.js</a>, <a href="user_kanban.js.html#line291">line 291</a>
|
|
2483
|
+
</span>
|
|
2484
|
+
</p>
|
|
2485
|
+
|
|
2486
|
+
</dl>
|
|
2487
|
+
|
|
2488
|
+
|
|
2489
|
+
|
|
2490
|
+
|
|
2491
|
+
|
|
2492
|
+
|
|
2493
|
+
|
|
2494
|
+
|
|
2495
|
+
|
|
2496
|
+
|
|
2497
|
+
|
|
2498
|
+
|
|
2499
|
+
|
|
2500
|
+
|
|
2501
|
+
|
|
2502
|
+
|
|
2503
|
+
|
|
2504
|
+
|
|
2505
|
+
<div class='columns method-parameter'>
|
|
2506
|
+
<div class="column is-2"><label>Returns:</label></div>
|
|
2507
|
+
<div class="column is-10">
|
|
2508
|
+
|
|
2509
|
+
|
|
2510
|
+
|
|
2511
|
+
<div class="columns">
|
|
2512
|
+
|
|
2513
|
+
<div class='param-desc column is-7'>Promise that resolves to operation status</div>
|
|
2514
|
+
|
|
2515
|
+
|
|
2516
|
+
<div class='column is-5 has-text-left'>
|
|
2517
|
+
<label>Type: </label>
|
|
2518
|
+
|
|
2519
|
+
<code class="param-type">promise</code>
|
|
2520
|
+
|
|
2521
|
+
|
|
2522
|
+
</div>
|
|
2523
|
+
|
|
2524
|
+
</div>
|
|
2525
|
+
|
|
2526
|
+
|
|
2527
|
+
|
|
2528
|
+
|
|
2529
|
+
<div class="columns">
|
|
2530
|
+
|
|
2531
|
+
<div class='param-desc column is-7'>returns.data - The response data containing:</div>
|
|
2532
|
+
|
|
2533
|
+
|
|
2534
|
+
<div class='column is-5 has-text-left'>
|
|
2535
|
+
<label>Type: </label>
|
|
2536
|
+
|
|
2537
|
+
<code class="param-type">Object</code>
|
|
2538
|
+
|
|
2539
|
+
|
|
2540
|
+
</div>
|
|
2541
|
+
|
|
2542
|
+
</div>
|
|
2543
|
+
|
|
2544
|
+
|
|
2545
|
+
|
|
2546
|
+
|
|
2547
|
+
<div class="columns">
|
|
2548
|
+
|
|
2549
|
+
<div class='param-desc column is-7'>returns.data.success - Indicates if the operation was successful</div>
|
|
2550
|
+
|
|
2551
|
+
|
|
2552
|
+
<div class='column is-5 has-text-left'>
|
|
2553
|
+
<label>Type: </label>
|
|
2554
|
+
|
|
2555
|
+
<code class="param-type">boolean</code>
|
|
2556
|
+
|
|
2557
|
+
|
|
2558
|
+
</div>
|
|
2559
|
+
|
|
2560
|
+
</div>
|
|
2561
|
+
|
|
2562
|
+
|
|
2563
|
+
|
|
2564
|
+
|
|
2565
|
+
<div class="columns">
|
|
2566
|
+
|
|
2567
|
+
<div class='param-desc column is-7'>[returns.data.error] - Error message if operation failed</div>
|
|
2568
|
+
|
|
2569
|
+
|
|
2570
|
+
<div class='column is-5 has-text-left'>
|
|
2571
|
+
<label>Type: </label>
|
|
2572
|
+
|
|
2573
|
+
<code class="param-type">string</code>
|
|
2574
|
+
|
|
2575
|
+
|
|
2576
|
+
</div>
|
|
2577
|
+
|
|
2578
|
+
</div>
|
|
2579
|
+
|
|
2580
|
+
|
|
2581
|
+
</div>
|
|
2582
|
+
</div>
|
|
2583
|
+
|
|
2584
|
+
|
|
2585
|
+
|
|
2586
|
+
|
|
2587
|
+
<h5>Example</h5>
|
|
2588
|
+
|
|
2589
|
+
|
|
2590
|
+
<pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
|
|
2591
|
+
const api = new API();
|
|
2592
|
+
const params = {
|
|
2593
|
+
orgId: '55e4a3bd6be6b45210833fae',
|
|
2594
|
+
taskId: '507f1f77bcf86cd799439011',
|
|
2595
|
+
status: 'in-progress'
|
|
2596
|
+
};
|
|
2597
|
+
const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
2598
|
+
const result = await api.user.kanban.updateTaskStatus(params, session);
|
|
2599
|
+
|
|
2600
|
+
Expected response structure (success):
|
|
2601
|
+
{
|
|
2602
|
+
success: true
|
|
2603
|
+
}
|
|
2604
|
+
|
|
2605
|
+
Expected response structure (error):
|
|
2606
|
+
{
|
|
2607
|
+
success: false,
|
|
2608
|
+
error: "Task not found"
|
|
2609
|
+
}</code></pre>
|
|
2610
|
+
|
|
2611
|
+
|
|
2612
|
+
|
|
2613
|
+
</div>
|
|
2614
|
+
|
|
2615
|
+
<div class="member">
|
|
2616
|
+
|
|
2617
|
+
|
|
2618
|
+
|
|
2619
|
+
<h4 class="name" id="updateTasksOrder">
|
|
2620
|
+
<a class="href-link" href="#updateTasksOrder">#</a>
|
|
2621
|
+
|
|
2622
|
+
|
|
2623
|
+
<span class='tag'>async</span>
|
|
2624
|
+
|
|
2625
|
+
|
|
2626
|
+
<span class="code-name">
|
|
2627
|
+
|
|
2628
|
+
updateTasksOrder<span class="signature">(params, session)</span><span class="type-signature"> → {promise|Object|boolean|string}</span>
|
|
2629
|
+
|
|
2630
|
+
</span>
|
|
2631
|
+
</h4>
|
|
2632
|
+
|
|
2633
|
+
|
|
2634
|
+
|
|
2635
|
+
|
|
2636
|
+
<div class="description">
|
|
2637
|
+
Updates the order of multiple tasks in their status columns on the Kanban board
|
|
2638
|
+
</div>
|
|
2639
|
+
|
|
2640
|
+
|
|
2641
|
+
|
|
2642
|
+
|
|
2643
|
+
|
|
2644
|
+
|
|
2645
|
+
|
|
2646
|
+
|
|
2647
|
+
|
|
2648
|
+
|
|
2649
|
+
<h5>Parameters:</h5>
|
|
2650
|
+
|
|
2651
|
+
<div class="table-container">
|
|
2652
|
+
<table class="params table">
|
|
2653
|
+
<thead>
|
|
2654
|
+
<tr>
|
|
2655
|
+
|
|
2656
|
+
<th>Name</th>
|
|
2657
|
+
|
|
2658
|
+
|
|
2659
|
+
<th>Type</th>
|
|
2660
|
+
|
|
2661
|
+
|
|
2662
|
+
|
|
2663
|
+
|
|
2664
|
+
|
|
2665
|
+
<th class="last">Description</th>
|
|
2666
|
+
</tr>
|
|
2667
|
+
</thead>
|
|
2668
|
+
|
|
2669
|
+
<tbody>
|
|
2670
|
+
|
|
2671
|
+
|
|
2672
|
+
|
|
2673
|
+
<tr class="deep-level-0">
|
|
2674
|
+
|
|
2675
|
+
<td class="name"><code>params</code></td>
|
|
2676
|
+
|
|
2677
|
+
|
|
2678
|
+
<td class="type">
|
|
2679
|
+
|
|
2680
|
+
|
|
2681
|
+
<code class="param-type">Object</code>
|
|
2682
|
+
|
|
2683
|
+
|
|
2684
|
+
|
|
2685
|
+
</td>
|
|
2686
|
+
|
|
2687
|
+
|
|
2688
|
+
|
|
2689
|
+
|
|
2690
|
+
|
|
2691
|
+
<td class="description last">Parameters object</td>
|
|
2692
|
+
</tr>
|
|
2693
|
+
|
|
2694
|
+
|
|
2695
|
+
|
|
2696
|
+
|
|
2697
|
+
<tr class="deep-level-1">
|
|
2698
|
+
|
|
2699
|
+
<td class="name"><code>orgId</code></td>
|
|
2700
|
+
|
|
2701
|
+
|
|
2702
|
+
<td class="type">
|
|
2703
|
+
|
|
2704
|
+
|
|
2705
|
+
<code class="param-type">string</code>
|
|
2706
|
+
|
|
2707
|
+
|
|
2708
|
+
|
|
2709
|
+
</td>
|
|
2710
|
+
|
|
2711
|
+
|
|
2712
|
+
|
|
2713
|
+
|
|
2714
|
+
|
|
2715
|
+
<td class="description last">Organization id (_id database)</td>
|
|
2716
|
+
</tr>
|
|
2717
|
+
|
|
2718
|
+
|
|
2719
|
+
|
|
2720
|
+
<tr class="deep-level-1">
|
|
2721
|
+
|
|
2722
|
+
<td class="name"><code>tasks</code></td>
|
|
2723
|
+
|
|
2724
|
+
|
|
2725
|
+
<td class="type">
|
|
2726
|
+
|
|
2727
|
+
|
|
2728
|
+
<code class="param-type">Array</code>
|
|
2729
|
+
|
|
2730
|
+
|
|
2731
|
+
|
|
2732
|
+
</td>
|
|
2733
|
+
|
|
2734
|
+
|
|
2735
|
+
|
|
2736
|
+
|
|
2737
|
+
|
|
2738
|
+
<td class="description last">Array of task objects containing taskId and order</td>
|
|
2739
|
+
</tr>
|
|
2740
|
+
|
|
2741
|
+
|
|
2742
|
+
|
|
2743
|
+
<tr class="deep-level-1">
|
|
2744
|
+
|
|
2745
|
+
<td class="name"><code>tasks[].taskId</code></td>
|
|
2746
|
+
|
|
2747
|
+
|
|
2748
|
+
<td class="type">
|
|
2749
|
+
|
|
2750
|
+
|
|
2751
|
+
<code class="param-type">string</code>
|
|
2752
|
+
|
|
2753
|
+
|
|
2754
|
+
|
|
2755
|
+
</td>
|
|
2756
|
+
|
|
2757
|
+
|
|
2758
|
+
|
|
2759
|
+
|
|
2760
|
+
|
|
2761
|
+
<td class="description last">The unique identifier of the task to update</td>
|
|
2762
|
+
</tr>
|
|
2763
|
+
|
|
2764
|
+
|
|
2765
|
+
|
|
2766
|
+
<tr class="deep-level-1">
|
|
2767
|
+
|
|
2768
|
+
<td class="name"><code>tasks[].order</code></td>
|
|
2769
|
+
|
|
2770
|
+
|
|
2771
|
+
<td class="type">
|
|
2772
|
+
|
|
2773
|
+
|
|
2774
|
+
<code class="param-type">number</code>
|
|
2775
|
+
|
|
2776
|
+
|
|
2777
|
+
|
|
2778
|
+
</td>
|
|
2779
|
+
|
|
2780
|
+
|
|
2781
|
+
|
|
2782
|
+
|
|
2783
|
+
|
|
2784
|
+
<td class="description last">The new order position for the task</td>
|
|
2785
|
+
</tr>
|
|
2786
|
+
|
|
2787
|
+
|
|
2788
|
+
|
|
2789
|
+
|
|
2790
|
+
|
|
2791
|
+
|
|
2792
|
+
|
|
2793
|
+
<tr class="deep-level-0">
|
|
2794
|
+
|
|
2795
|
+
<td class="name"><code>session</code></td>
|
|
2796
|
+
|
|
2797
|
+
|
|
2798
|
+
<td class="type">
|
|
2799
|
+
|
|
2800
|
+
|
|
2801
|
+
<code class="param-type">string</code>
|
|
2802
|
+
|
|
2803
|
+
|
|
2804
|
+
|
|
2805
|
+
</td>
|
|
2806
|
+
|
|
2807
|
+
|
|
2808
|
+
|
|
2809
|
+
|
|
2810
|
+
|
|
2811
|
+
<td class="description last">Session, token JWT</td>
|
|
2812
|
+
</tr>
|
|
2813
|
+
|
|
2814
|
+
|
|
2815
|
+
|
|
2816
|
+
</tbody>
|
|
2817
|
+
</table>
|
|
2818
|
+
</div>
|
|
2819
|
+
|
|
2820
|
+
|
|
2821
|
+
|
|
2822
|
+
|
|
2823
|
+
|
|
2824
|
+
<dl class="details">
|
|
2825
|
+
|
|
2826
|
+
|
|
2827
|
+
|
|
2828
|
+
|
|
2829
|
+
|
|
2830
|
+
|
|
2831
|
+
|
|
2832
|
+
|
|
2833
|
+
|
|
2834
|
+
|
|
2835
|
+
|
|
2836
|
+
|
|
2837
|
+
|
|
2838
|
+
|
|
2839
|
+
|
|
2840
|
+
|
|
2841
|
+
|
|
2842
|
+
|
|
2843
|
+
<dt class="tag-author">Author:</dt>
|
|
2844
|
+
<dd class="tag-author">
|
|
2845
|
+
<ul>
|
|
2846
|
+
<li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
|
|
2847
|
+
</ul>
|
|
2848
|
+
</dd>
|
|
2849
|
+
|
|
2850
|
+
|
|
2851
|
+
|
|
2852
|
+
|
|
2853
|
+
|
|
2854
|
+
|
|
2855
|
+
|
|
2856
|
+
|
|
2857
|
+
|
|
2858
|
+
|
|
2859
|
+
|
|
2860
|
+
|
|
2861
|
+
|
|
2862
|
+
|
|
2863
|
+
<p class="tag-source">
|
|
2864
|
+
<a href="user_kanban.js.html" class="button">View Source</a>
|
|
2865
|
+
<span>
|
|
2866
|
+
<a href="user_kanban.js.html">user/kanban.js</a>, <a href="user_kanban.js.html#line232">line 232</a>
|
|
2867
|
+
</span>
|
|
2868
|
+
</p>
|
|
2869
|
+
|
|
2870
|
+
</dl>
|
|
2871
|
+
|
|
2872
|
+
|
|
2873
|
+
|
|
2874
|
+
|
|
2875
|
+
|
|
2876
|
+
|
|
2877
|
+
|
|
2878
|
+
|
|
2879
|
+
|
|
2880
|
+
|
|
2881
|
+
|
|
2882
|
+
|
|
2883
|
+
|
|
2884
|
+
|
|
2885
|
+
|
|
2886
|
+
|
|
2887
|
+
|
|
2888
|
+
|
|
2889
|
+
<div class='columns method-parameter'>
|
|
2890
|
+
<div class="column is-2"><label>Returns:</label></div>
|
|
2891
|
+
<div class="column is-10">
|
|
2892
|
+
|
|
2893
|
+
|
|
2894
|
+
|
|
2895
|
+
<div class="columns">
|
|
2896
|
+
|
|
2897
|
+
<div class='param-desc column is-7'>Promise that resolves to operation status</div>
|
|
2898
|
+
|
|
2899
|
+
|
|
2900
|
+
<div class='column is-5 has-text-left'>
|
|
2901
|
+
<label>Type: </label>
|
|
2902
|
+
|
|
2903
|
+
<code class="param-type">promise</code>
|
|
2904
|
+
|
|
2905
|
+
|
|
2906
|
+
</div>
|
|
2907
|
+
|
|
2908
|
+
</div>
|
|
2909
|
+
|
|
2910
|
+
|
|
2911
|
+
|
|
2912
|
+
|
|
2913
|
+
<div class="columns">
|
|
2914
|
+
|
|
2915
|
+
<div class='param-desc column is-7'>returns.data - The response data containing:</div>
|
|
2916
|
+
|
|
2917
|
+
|
|
2918
|
+
<div class='column is-5 has-text-left'>
|
|
2919
|
+
<label>Type: </label>
|
|
2920
|
+
|
|
2921
|
+
<code class="param-type">Object</code>
|
|
2922
|
+
|
|
2923
|
+
|
|
2924
|
+
</div>
|
|
2925
|
+
|
|
2926
|
+
</div>
|
|
2927
|
+
|
|
2928
|
+
|
|
2929
|
+
|
|
2930
|
+
|
|
2931
|
+
<div class="columns">
|
|
2932
|
+
|
|
2933
|
+
<div class='param-desc column is-7'>returns.data.success - Indicates if the operation was successful</div>
|
|
2934
|
+
|
|
2935
|
+
|
|
2936
|
+
<div class='column is-5 has-text-left'>
|
|
2937
|
+
<label>Type: </label>
|
|
2938
|
+
|
|
2939
|
+
<code class="param-type">boolean</code>
|
|
2940
|
+
|
|
2941
|
+
|
|
2942
|
+
</div>
|
|
2943
|
+
|
|
2944
|
+
</div>
|
|
2945
|
+
|
|
2946
|
+
|
|
2947
|
+
|
|
2948
|
+
|
|
2949
|
+
<div class="columns">
|
|
2950
|
+
|
|
2951
|
+
<div class='param-desc column is-7'>[returns.data.error] - Error message if operation failed</div>
|
|
2952
|
+
|
|
2953
|
+
|
|
2954
|
+
<div class='column is-5 has-text-left'>
|
|
2955
|
+
<label>Type: </label>
|
|
2956
|
+
|
|
2957
|
+
<code class="param-type">string</code>
|
|
2958
|
+
|
|
2959
|
+
|
|
2960
|
+
</div>
|
|
2961
|
+
|
|
2962
|
+
</div>
|
|
2963
|
+
|
|
2964
|
+
|
|
2965
|
+
</div>
|
|
2966
|
+
</div>
|
|
2967
|
+
|
|
2968
|
+
|
|
2969
|
+
|
|
2970
|
+
|
|
2971
|
+
<h5>Example</h5>
|
|
2972
|
+
|
|
2973
|
+
|
|
2974
|
+
<pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
|
|
2975
|
+
const api = new API();
|
|
2976
|
+
const params = {
|
|
2977
|
+
orgId: '55e4a3bd6be6b45210833fae',
|
|
2978
|
+
tasks: [
|
|
2979
|
+
{ taskId: '507f1f77bcf86cd799439011', order: 1 },
|
|
2980
|
+
{ taskId: '507f1f77bcf86cd799439012', order: 2 },
|
|
2981
|
+
{ taskId: '507f1f77bcf86cd799439013', order: 3 }
|
|
2982
|
+
]
|
|
2983
|
+
};
|
|
2984
|
+
const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
2985
|
+
const result = await api.user.kanban.updateTasksOrder(params, session);
|
|
2986
|
+
|
|
2987
|
+
Expected response structure (success):
|
|
2988
|
+
{
|
|
2989
|
+
success: true
|
|
2990
|
+
}
|
|
2991
|
+
|
|
2992
|
+
Expected response structure (error):
|
|
2993
|
+
{
|
|
2994
|
+
success: false,
|
|
2995
|
+
error: "One or more tasks not found"
|
|
2996
|
+
}</code></pre>
|
|
2997
|
+
|
|
2998
|
+
|
|
2999
|
+
|
|
3000
|
+
</div>
|
|
3001
|
+
|
|
3002
|
+
</div>
|
|
3003
|
+
</div>
|
|
3004
|
+
|
|
3005
|
+
|
|
3006
|
+
|
|
3007
|
+
|
|
3008
|
+
|
|
3009
|
+
</article>
|
|
3010
|
+
|
|
3011
|
+
</section>
|
|
3012
|
+
|
|
3013
|
+
|
|
3014
|
+
|
|
3015
|
+
|
|
3016
|
+
</div>
|
|
3017
|
+
|
|
3018
|
+
<footer class="footer">
|
|
3019
|
+
<div class="content has-text-centered">
|
|
3020
|
+
<p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a></p>
|
|
3021
|
+
<p class="sidebar-created-by">
|
|
3022
|
+
<a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
|
|
3023
|
+
<a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
|
|
3024
|
+
</p>
|
|
3025
|
+
</div>
|
|
3026
|
+
</footer>
|
|
3027
|
+
|
|
3028
|
+
</div>
|
|
3029
|
+
<div id="side-nav" class="side-nav">
|
|
3030
|
+
</div>
|
|
3031
|
+
</div>
|
|
3032
|
+
<script src="scripts/app.min.js"></script>
|
|
3033
|
+
<script>PR.prettyPrint();</script>
|
|
3034
|
+
<script src="scripts/linenumber.js"> </script>
|
|
3035
|
+
|
|
3036
|
+
|
|
3037
|
+
</body>
|
|
3038
|
+
</html>
|