@docbrasil/api-systemmanager 1.0.107 → 1.0.109
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/.github/workflows/static.yml +43 -0
- package/api/external.js +41 -0
- package/dist/bundle.cjs +41 -0
- package/dist/bundle.mjs +1 -1
- package/doc/api.md +382 -0
- package/docs/Admin.html +336 -0
- package/docs/AdminDocuments.html +2235 -0
- package/docs/AdminForm.html +934 -0
- package/docs/AdminLists.html +895 -0
- package/docs/AdminMessage.html +1490 -0
- package/docs/AdminNotification.html +1636 -0
- package/docs/AdminPlugin.html +696 -0
- package/docs/AdminPolicy.html +451 -0
- package/docs/AdminProcesses.html +692 -0
- package/docs/AdminTask.html +740 -0
- package/docs/AdminUser.html +1203 -0
- package/docs/Datasource.html +660 -0
- package/docs/Dispatch.html +624 -0
- package/docs/Documents.html +4875 -0
- package/docs/External.html +1497 -0
- package/docs/GeoLocation.html +503 -0
- package/docs/Login.html +1839 -0
- package/docs/Notification.html +625 -0
- package/docs/Organization.html +2767 -0
- package/docs/Process.html +1598 -0
- package/docs/Register.html +1604 -0
- package/docs/Session.html +482 -0
- package/docs/Task.html +1394 -0
- package/docs/TaskAvailable.html +893 -0
- package/docs/User.html +2002 -0
- package/docs/Users.html +569 -0
- package/docs/admin_doctypes.js.html +193 -0
- package/docs/admin_document.js.html +449 -0
- package/docs/admin_form.js.html +268 -0
- package/docs/admin_index.js.html +163 -0
- package/docs/admin_list.js.html +250 -0
- package/docs/admin_message.js.html +311 -0
- package/docs/admin_notification.js.html +350 -0
- package/docs/admin_organization.js.html +241 -0
- package/docs/admin_plugin.js.html +233 -0
- package/docs/admin_policy.js.html +195 -0
- package/docs/admin_processes.js.html +487 -0
- package/docs/admin_task.js.html +242 -0
- package/docs/admin_user.js.html +302 -0
- package/docs/dispatch.js.html +218 -0
- package/docs/external.js.html +333 -0
- package/docs/general_geoLocation.js.html +205 -0
- package/docs/general_index.js.html +140 -0
- package/docs/index.html +129 -0
- package/docs/login.js.html +384 -0
- package/docs/scripts/app.min.js +1 -0
- package/docs/scripts/linenumber.js +26 -0
- package/docs/scripts/search.js +39 -0
- package/docs/session.js.html +202 -0
- package/docs/styles/app.min.css +1 -0
- package/docs/styles/iframe.css +13 -0
- package/docs/styles/prettify-jsdoc.css +111 -0
- package/docs/styles/prettify-tomorrow.css +132 -0
- package/docs/styles/reset.css +44 -0
- package/docs/user_datasource.js.html +261 -0
- package/docs/user_document.js.html +847 -0
- package/docs/user_index.js.html +156 -0
- package/docs/user_notification.js.html +218 -0
- package/docs/user_organization.js.html +347 -0
- package/docs/user_process.js.html +352 -0
- package/docs/user_register.js.html +322 -0
- package/docs/user_task.js.html +319 -0
- package/docs/user_task_available.js.html +252 -0
- package/docs/user_user.js.html +404 -0
- package/docs/utils_promises.js.html +235 -0
- package/package.json +7 -4
- package/readme.md +7 -8
- package/doc.md +0 -653
|
@@ -0,0 +1,1598 @@
|
|
|
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> Process</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="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="Login.html">Login</a></li><li><a href="Notification.html">Notification</a></li><li><a href="Organization.html">Organization</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="Task.html">Task</a></li><li><a href="TaskAvailable.html">TaskAvailable</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>Process</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>Process<span class="signature">()</span><span class="type-signature"></span></h2>
|
|
89
|
+
|
|
90
|
+
<div class="class-description">Class for process, 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="Process">
|
|
110
|
+
<a class="href-link" href="#Process">#</a>
|
|
111
|
+
|
|
112
|
+
<span class="code-name">
|
|
113
|
+
|
|
114
|
+
new Process<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_process.js.html" class="button">View Source</a>
|
|
169
|
+
<span>
|
|
170
|
+
<a href="user_process.js.html">user/process.js</a>, <a href="user_process.js.html#line9">line 9</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="find">
|
|
228
|
+
<a class="href-link" href="#find">#</a>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
<span class='tag'>async</span>
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
<span class="code-name">
|
|
235
|
+
|
|
236
|
+
find<span class="signature">(params, session)</span><span class="type-signature"> → {promise|number|array.<object>|number|number}</span>
|
|
237
|
+
|
|
238
|
+
</span>
|
|
239
|
+
</h4>
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
<div class="description">
|
|
245
|
+
Method to search processes
|
|
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">Params to search processes</td>
|
|
300
|
+
</tr>
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
<tr class="deep-level-1">
|
|
306
|
+
|
|
307
|
+
<td class="name"><code>query</code></td>
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
<td class="type">
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
<code class="param-type">object</code>
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
</td>
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
<td class="description last">Search process query</td>
|
|
324
|
+
</tr>
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
<tr class="deep-level-1">
|
|
329
|
+
|
|
330
|
+
<td class="name"><code>orgId</code></td>
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
<td class="type">
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
<code class="param-type">object</code>
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
</td>
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
<td class="description last">Organization id (_id database)</td>
|
|
347
|
+
</tr>
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
<tr class="deep-level-0">
|
|
356
|
+
|
|
357
|
+
<td class="name"><code>session</code></td>
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
<td class="type">
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
<code class="param-type">string</code>
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
</td>
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
<td class="description last">Session, token JWT</td>
|
|
374
|
+
</tr>
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
</tbody>
|
|
379
|
+
</table>
|
|
380
|
+
</div>
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
<dl class="details">
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
<dt class="tag-author">Author:</dt>
|
|
406
|
+
<dd class="tag-author">
|
|
407
|
+
<ul>
|
|
408
|
+
<li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
|
|
409
|
+
</ul>
|
|
410
|
+
</dd>
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
<p class="tag-source">
|
|
426
|
+
<a href="user_process.js.html" class="button">View Source</a>
|
|
427
|
+
<span>
|
|
428
|
+
<a href="user_process.js.html">user/process.js</a>, <a href="user_process.js.html#line214">line 214</a>
|
|
429
|
+
</span>
|
|
430
|
+
</p>
|
|
431
|
+
|
|
432
|
+
</dl>
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
<div class='columns method-parameter'>
|
|
452
|
+
<div class="column is-2"><label>Returns:</label></div>
|
|
453
|
+
<div class="column is-10">
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
<div class="columns">
|
|
458
|
+
|
|
459
|
+
<div class='param-desc column is-7'>returned data from the search</div>
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
<div class='column is-5 has-text-left'>
|
|
463
|
+
<label>Type: </label>
|
|
464
|
+
|
|
465
|
+
<code class="param-type">promise</code>
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
</div>
|
|
469
|
+
|
|
470
|
+
</div>
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
<div class="columns">
|
|
476
|
+
|
|
477
|
+
<div class='param-desc column is-7'>count the count of items searched</div>
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
<div class='column is-5 has-text-left'>
|
|
481
|
+
<label>Type: </label>
|
|
482
|
+
|
|
483
|
+
<code class="param-type">number</code>
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
</div>
|
|
487
|
+
|
|
488
|
+
</div>
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
<div class="columns">
|
|
494
|
+
|
|
495
|
+
<div class='param-desc column is-7'>items the items returned from search</div>
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
<div class='column is-5 has-text-left'>
|
|
499
|
+
<label>Type: </label>
|
|
500
|
+
|
|
501
|
+
<code class="param-type">array.<object></code>
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
</div>
|
|
505
|
+
|
|
506
|
+
</div>
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
<div class="columns">
|
|
512
|
+
|
|
513
|
+
<div class='param-desc column is-7'>page the page of the search (on pagination), zero indexed</div>
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
<div class='column is-5 has-text-left'>
|
|
517
|
+
<label>Type: </label>
|
|
518
|
+
|
|
519
|
+
<code class="param-type">number</code>
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
</div>
|
|
523
|
+
|
|
524
|
+
</div>
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
<div class="columns">
|
|
530
|
+
|
|
531
|
+
<div class='param-desc column is-7'>perPage how many items per page</div>
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
<div class='column is-5 has-text-left'>
|
|
535
|
+
<label>Type: </label>
|
|
536
|
+
|
|
537
|
+
<code class="param-type">number</code>
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
</div>
|
|
541
|
+
|
|
542
|
+
</div>
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
</div>
|
|
546
|
+
</div>
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
<h5>Example</h5>
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
<pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
|
|
555
|
+
const api = new API();
|
|
556
|
+
const params = {
|
|
557
|
+
query: {"orgProcessId": {"value":"62c2d1cdfb5455c195d1baa1","oper":"=","type":"string"},"s":[{"historyBegin":{"order":"desc"}}],"i":1,"p":20},
|
|
558
|
+
orgId: '55e4a3bd6be6b45210833fae',
|
|
559
|
+
};
|
|
560
|
+
const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
561
|
+
const retSearch = await api.user.process.find(params, session);</code></pre>
|
|
562
|
+
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
</div>
|
|
566
|
+
|
|
567
|
+
<div class="member">
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
<h4 class="name" id="getOrgProcessSearchInfo">
|
|
572
|
+
<a class="href-link" href="#getOrgProcessSearchInfo">#</a>
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
<span class='tag'>async</span>
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
<span class="code-name">
|
|
579
|
+
|
|
580
|
+
getOrgProcessSearchInfo<span class="signature">(params, session)</span><span class="type-signature"> → {Promise|string|object|object|object|string}</span>
|
|
581
|
+
|
|
582
|
+
</span>
|
|
583
|
+
</h4>
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
<div class="description">
|
|
589
|
+
Get the search info of a organization process
|
|
590
|
+
</div>
|
|
591
|
+
|
|
592
|
+
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
<h5>Parameters:</h5>
|
|
602
|
+
|
|
603
|
+
<div class="table-container">
|
|
604
|
+
<table class="params table">
|
|
605
|
+
<thead>
|
|
606
|
+
<tr>
|
|
607
|
+
|
|
608
|
+
<th>Name</th>
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
<th>Type</th>
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
<th class="last">Description</th>
|
|
618
|
+
</tr>
|
|
619
|
+
</thead>
|
|
620
|
+
|
|
621
|
+
<tbody>
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
<tr class="deep-level-0">
|
|
626
|
+
|
|
627
|
+
<td class="name"><code>params</code></td>
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
<td class="type">
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
<code class="param-type">object</code>
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
</td>
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
<td class="description last">Params to get search info</td>
|
|
644
|
+
</tr>
|
|
645
|
+
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
<tr class="deep-level-1">
|
|
650
|
+
|
|
651
|
+
<td class="name"><code>orgProcessId</code></td>
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
<td class="type">
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
<code class="param-type">string</code>
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
</td>
|
|
662
|
+
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
|
|
667
|
+
<td class="description last">The id of an organization process (_id database);</td>
|
|
668
|
+
</tr>
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
|
|
672
|
+
<tr class="deep-level-1">
|
|
673
|
+
|
|
674
|
+
<td class="name"><code>orgId</code></td>
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
<td class="type">
|
|
678
|
+
|
|
679
|
+
|
|
680
|
+
<code class="param-type">string</code>
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
</td>
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
<td class="description last">Organization id (_id database);</td>
|
|
691
|
+
</tr>
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
|
|
699
|
+
<tr class="deep-level-0">
|
|
700
|
+
|
|
701
|
+
<td class="name"><code>session</code></td>
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
<td class="type">
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
<code class="param-type">string</code>
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
|
|
711
|
+
</td>
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
<td class="description last">Session, token JWT</td>
|
|
718
|
+
</tr>
|
|
719
|
+
|
|
720
|
+
|
|
721
|
+
|
|
722
|
+
</tbody>
|
|
723
|
+
</table>
|
|
724
|
+
</div>
|
|
725
|
+
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
<dl class="details">
|
|
731
|
+
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
|
|
737
|
+
|
|
738
|
+
|
|
739
|
+
|
|
740
|
+
|
|
741
|
+
|
|
742
|
+
|
|
743
|
+
|
|
744
|
+
|
|
745
|
+
|
|
746
|
+
|
|
747
|
+
|
|
748
|
+
|
|
749
|
+
<dt class="tag-author">Author:</dt>
|
|
750
|
+
<dd class="tag-author">
|
|
751
|
+
<ul>
|
|
752
|
+
<li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
|
|
753
|
+
</ul>
|
|
754
|
+
</dd>
|
|
755
|
+
|
|
756
|
+
|
|
757
|
+
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
|
|
766
|
+
|
|
767
|
+
|
|
768
|
+
|
|
769
|
+
<p class="tag-source">
|
|
770
|
+
<a href="user_process.js.html" class="button">View Source</a>
|
|
771
|
+
<span>
|
|
772
|
+
<a href="user_process.js.html">user/process.js</a>, <a href="user_process.js.html#line173">line 173</a>
|
|
773
|
+
</span>
|
|
774
|
+
</p>
|
|
775
|
+
|
|
776
|
+
</dl>
|
|
777
|
+
|
|
778
|
+
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
|
|
786
|
+
|
|
787
|
+
|
|
788
|
+
|
|
789
|
+
|
|
790
|
+
|
|
791
|
+
|
|
792
|
+
|
|
793
|
+
|
|
794
|
+
|
|
795
|
+
<div class='columns method-parameter'>
|
|
796
|
+
<div class="column is-2"><label>Returns:</label></div>
|
|
797
|
+
<div class="column is-10">
|
|
798
|
+
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
<div class="columns">
|
|
802
|
+
|
|
803
|
+
<div class='param-desc column is-7'>the search info result</div>
|
|
804
|
+
|
|
805
|
+
|
|
806
|
+
<div class='column is-5 has-text-left'>
|
|
807
|
+
<label>Type: </label>
|
|
808
|
+
|
|
809
|
+
<code class="param-type">Promise</code>
|
|
810
|
+
|
|
811
|
+
|
|
812
|
+
</div>
|
|
813
|
+
|
|
814
|
+
</div>
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
<div class="columns">
|
|
820
|
+
|
|
821
|
+
<div class='param-desc column is-7'>name the name of the organization process</div>
|
|
822
|
+
|
|
823
|
+
|
|
824
|
+
<div class='column is-5 has-text-left'>
|
|
825
|
+
<label>Type: </label>
|
|
826
|
+
|
|
827
|
+
<code class="param-type">string</code>
|
|
828
|
+
|
|
829
|
+
|
|
830
|
+
</div>
|
|
831
|
+
|
|
832
|
+
</div>
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
<div class="columns">
|
|
838
|
+
|
|
839
|
+
<div class='param-desc column is-7'>processIndexFields the list of fields to index</div>
|
|
840
|
+
|
|
841
|
+
|
|
842
|
+
<div class='column is-5 has-text-left'>
|
|
843
|
+
<label>Type: </label>
|
|
844
|
+
|
|
845
|
+
<code class="param-type">object</code>
|
|
846
|
+
|
|
847
|
+
|
|
848
|
+
</div>
|
|
849
|
+
|
|
850
|
+
</div>
|
|
851
|
+
|
|
852
|
+
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
<div class="columns">
|
|
856
|
+
|
|
857
|
+
<div class='param-desc column is-7'>processParticipantsGroup the permissions in this organization process</div>
|
|
858
|
+
|
|
859
|
+
|
|
860
|
+
<div class='column is-5 has-text-left'>
|
|
861
|
+
<label>Type: </label>
|
|
862
|
+
|
|
863
|
+
<code class="param-type">object</code>
|
|
864
|
+
|
|
865
|
+
|
|
866
|
+
</div>
|
|
867
|
+
|
|
868
|
+
</div>
|
|
869
|
+
|
|
870
|
+
|
|
871
|
+
|
|
872
|
+
|
|
873
|
+
<div class="columns">
|
|
874
|
+
|
|
875
|
+
<div class='param-desc column is-7'>stepsProperties the organization process steps properties</div>
|
|
876
|
+
|
|
877
|
+
|
|
878
|
+
<div class='column is-5 has-text-left'>
|
|
879
|
+
<label>Type: </label>
|
|
880
|
+
|
|
881
|
+
<code class="param-type">object</code>
|
|
882
|
+
|
|
883
|
+
|
|
884
|
+
</div>
|
|
885
|
+
|
|
886
|
+
</div>
|
|
887
|
+
|
|
888
|
+
|
|
889
|
+
|
|
890
|
+
|
|
891
|
+
<div class="columns">
|
|
892
|
+
|
|
893
|
+
<div class='param-desc column is-7'>_id the same organization id
|
|
894
|
+
@</div>
|
|
895
|
+
|
|
896
|
+
|
|
897
|
+
<div class='column is-5 has-text-left'>
|
|
898
|
+
<label>Type: </label>
|
|
899
|
+
|
|
900
|
+
<code class="param-type">string</code>
|
|
901
|
+
|
|
902
|
+
|
|
903
|
+
</div>
|
|
904
|
+
|
|
905
|
+
</div>
|
|
906
|
+
|
|
907
|
+
|
|
908
|
+
</div>
|
|
909
|
+
</div>
|
|
910
|
+
|
|
911
|
+
|
|
912
|
+
|
|
913
|
+
|
|
914
|
+
<h5>Example</h5>
|
|
915
|
+
|
|
916
|
+
|
|
917
|
+
<pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
|
|
918
|
+
const api = new API();
|
|
919
|
+
const params = {
|
|
920
|
+
orgProcessId: '5dadd01dc4af3941d42f8c67',
|
|
921
|
+
orgId: '5edd11c46b6ce9729c2c297c',
|
|
922
|
+
}
|
|
923
|
+
const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
924
|
+
const retSearchInfo = await api.user.process.getOrgProcessSearchInfo(params, session);</code></pre>
|
|
925
|
+
|
|
926
|
+
|
|
927
|
+
|
|
928
|
+
</div>
|
|
929
|
+
|
|
930
|
+
<div class="member">
|
|
931
|
+
|
|
932
|
+
|
|
933
|
+
|
|
934
|
+
<h4 class="name" id="getProcessProperties">
|
|
935
|
+
<a class="href-link" href="#getProcessProperties">#</a>
|
|
936
|
+
|
|
937
|
+
|
|
938
|
+
<span class='tag'>async</span>
|
|
939
|
+
|
|
940
|
+
|
|
941
|
+
<span class="code-name">
|
|
942
|
+
|
|
943
|
+
getProcessProperties<span class="signature">(params, session)</span><span class="type-signature"> → {Promise}</span>
|
|
944
|
+
|
|
945
|
+
</span>
|
|
946
|
+
</h4>
|
|
947
|
+
|
|
948
|
+
|
|
949
|
+
|
|
950
|
+
|
|
951
|
+
<div class="description">
|
|
952
|
+
Get process properties of process
|
|
953
|
+
</div>
|
|
954
|
+
|
|
955
|
+
|
|
956
|
+
|
|
957
|
+
|
|
958
|
+
|
|
959
|
+
|
|
960
|
+
|
|
961
|
+
|
|
962
|
+
|
|
963
|
+
|
|
964
|
+
<h5>Parameters:</h5>
|
|
965
|
+
|
|
966
|
+
<div class="table-container">
|
|
967
|
+
<table class="params table">
|
|
968
|
+
<thead>
|
|
969
|
+
<tr>
|
|
970
|
+
|
|
971
|
+
<th>Name</th>
|
|
972
|
+
|
|
973
|
+
|
|
974
|
+
<th>Type</th>
|
|
975
|
+
|
|
976
|
+
|
|
977
|
+
|
|
978
|
+
|
|
979
|
+
|
|
980
|
+
<th class="last">Description</th>
|
|
981
|
+
</tr>
|
|
982
|
+
</thead>
|
|
983
|
+
|
|
984
|
+
<tbody>
|
|
985
|
+
|
|
986
|
+
|
|
987
|
+
|
|
988
|
+
<tr class="deep-level-0">
|
|
989
|
+
|
|
990
|
+
<td class="name"><code>params</code></td>
|
|
991
|
+
|
|
992
|
+
|
|
993
|
+
<td class="type">
|
|
994
|
+
|
|
995
|
+
|
|
996
|
+
<code class="param-type">object</code>
|
|
997
|
+
|
|
998
|
+
|
|
999
|
+
|
|
1000
|
+
</td>
|
|
1001
|
+
|
|
1002
|
+
|
|
1003
|
+
|
|
1004
|
+
|
|
1005
|
+
|
|
1006
|
+
<td class="description last">Params to get process properties</td>
|
|
1007
|
+
</tr>
|
|
1008
|
+
|
|
1009
|
+
|
|
1010
|
+
|
|
1011
|
+
|
|
1012
|
+
<tr class="deep-level-1">
|
|
1013
|
+
|
|
1014
|
+
<td class="name"><code>processId</code></td>
|
|
1015
|
+
|
|
1016
|
+
|
|
1017
|
+
<td class="type">
|
|
1018
|
+
|
|
1019
|
+
|
|
1020
|
+
<code class="param-type">string</code>
|
|
1021
|
+
|
|
1022
|
+
|
|
1023
|
+
|
|
1024
|
+
</td>
|
|
1025
|
+
|
|
1026
|
+
|
|
1027
|
+
|
|
1028
|
+
|
|
1029
|
+
|
|
1030
|
+
<td class="description last">Process id (_id database);</td>
|
|
1031
|
+
</tr>
|
|
1032
|
+
|
|
1033
|
+
|
|
1034
|
+
|
|
1035
|
+
<tr class="deep-level-1">
|
|
1036
|
+
|
|
1037
|
+
<td class="name"><code>orgId</code></td>
|
|
1038
|
+
|
|
1039
|
+
|
|
1040
|
+
<td class="type">
|
|
1041
|
+
|
|
1042
|
+
|
|
1043
|
+
<code class="param-type">string</code>
|
|
1044
|
+
|
|
1045
|
+
|
|
1046
|
+
|
|
1047
|
+
</td>
|
|
1048
|
+
|
|
1049
|
+
|
|
1050
|
+
|
|
1051
|
+
|
|
1052
|
+
|
|
1053
|
+
<td class="description last">Organization id (_id database);</td>
|
|
1054
|
+
</tr>
|
|
1055
|
+
|
|
1056
|
+
|
|
1057
|
+
|
|
1058
|
+
|
|
1059
|
+
|
|
1060
|
+
|
|
1061
|
+
|
|
1062
|
+
<tr class="deep-level-0">
|
|
1063
|
+
|
|
1064
|
+
<td class="name"><code>session</code></td>
|
|
1065
|
+
|
|
1066
|
+
|
|
1067
|
+
<td class="type">
|
|
1068
|
+
|
|
1069
|
+
|
|
1070
|
+
<code class="param-type">string</code>
|
|
1071
|
+
|
|
1072
|
+
|
|
1073
|
+
|
|
1074
|
+
</td>
|
|
1075
|
+
|
|
1076
|
+
|
|
1077
|
+
|
|
1078
|
+
|
|
1079
|
+
|
|
1080
|
+
<td class="description last">Session, token JWT</td>
|
|
1081
|
+
</tr>
|
|
1082
|
+
|
|
1083
|
+
|
|
1084
|
+
|
|
1085
|
+
</tbody>
|
|
1086
|
+
</table>
|
|
1087
|
+
</div>
|
|
1088
|
+
|
|
1089
|
+
|
|
1090
|
+
|
|
1091
|
+
|
|
1092
|
+
|
|
1093
|
+
<dl class="details">
|
|
1094
|
+
|
|
1095
|
+
|
|
1096
|
+
|
|
1097
|
+
|
|
1098
|
+
|
|
1099
|
+
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
|
|
1103
|
+
|
|
1104
|
+
|
|
1105
|
+
|
|
1106
|
+
|
|
1107
|
+
|
|
1108
|
+
|
|
1109
|
+
|
|
1110
|
+
|
|
1111
|
+
|
|
1112
|
+
<dt class="tag-author">Author:</dt>
|
|
1113
|
+
<dd class="tag-author">
|
|
1114
|
+
<ul>
|
|
1115
|
+
<li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
|
|
1116
|
+
</ul>
|
|
1117
|
+
</dd>
|
|
1118
|
+
|
|
1119
|
+
|
|
1120
|
+
|
|
1121
|
+
|
|
1122
|
+
|
|
1123
|
+
|
|
1124
|
+
|
|
1125
|
+
|
|
1126
|
+
|
|
1127
|
+
|
|
1128
|
+
|
|
1129
|
+
|
|
1130
|
+
|
|
1131
|
+
|
|
1132
|
+
<p class="tag-source">
|
|
1133
|
+
<a href="user_process.js.html" class="button">View Source</a>
|
|
1134
|
+
<span>
|
|
1135
|
+
<a href="user_process.js.html">user/process.js</a>, <a href="user_process.js.html#line129">line 129</a>
|
|
1136
|
+
</span>
|
|
1137
|
+
</p>
|
|
1138
|
+
|
|
1139
|
+
</dl>
|
|
1140
|
+
|
|
1141
|
+
|
|
1142
|
+
|
|
1143
|
+
|
|
1144
|
+
|
|
1145
|
+
|
|
1146
|
+
|
|
1147
|
+
|
|
1148
|
+
|
|
1149
|
+
|
|
1150
|
+
|
|
1151
|
+
|
|
1152
|
+
|
|
1153
|
+
|
|
1154
|
+
|
|
1155
|
+
|
|
1156
|
+
|
|
1157
|
+
|
|
1158
|
+
<div class='columns method-parameter'>
|
|
1159
|
+
<div class="column is-2"><label>Returns:</label></div>
|
|
1160
|
+
<div class="column is-10">
|
|
1161
|
+
|
|
1162
|
+
|
|
1163
|
+
|
|
1164
|
+
<div class="columns">
|
|
1165
|
+
|
|
1166
|
+
|
|
1167
|
+
<div class='column is-5 has-text-left'>
|
|
1168
|
+
<label>Type: </label>
|
|
1169
|
+
|
|
1170
|
+
<code class="param-type">Promise</code>
|
|
1171
|
+
|
|
1172
|
+
|
|
1173
|
+
</div>
|
|
1174
|
+
|
|
1175
|
+
</div>
|
|
1176
|
+
|
|
1177
|
+
|
|
1178
|
+
</div>
|
|
1179
|
+
</div>
|
|
1180
|
+
|
|
1181
|
+
|
|
1182
|
+
|
|
1183
|
+
|
|
1184
|
+
<h5>Example</h5>
|
|
1185
|
+
|
|
1186
|
+
|
|
1187
|
+
<pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
|
|
1188
|
+
const api = new API();
|
|
1189
|
+
const params = {
|
|
1190
|
+
processId: '5dadd01dc4af3941d42f8c5c',
|
|
1191
|
+
orgId: '5edd11c46b6ce9729c2c297c',
|
|
1192
|
+
}
|
|
1193
|
+
const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
1194
|
+
await api.user.process.getProcessProperties(params, session);</code></pre>
|
|
1195
|
+
|
|
1196
|
+
|
|
1197
|
+
|
|
1198
|
+
</div>
|
|
1199
|
+
|
|
1200
|
+
<div class="member">
|
|
1201
|
+
|
|
1202
|
+
|
|
1203
|
+
|
|
1204
|
+
<h4 class="name" id="start">
|
|
1205
|
+
<a class="href-link" href="#start">#</a>
|
|
1206
|
+
|
|
1207
|
+
|
|
1208
|
+
<span class='tag'>async</span>
|
|
1209
|
+
|
|
1210
|
+
|
|
1211
|
+
<span class="code-name">
|
|
1212
|
+
|
|
1213
|
+
start<span class="signature">(params, session)</span><span class="type-signature"> → {Promise}</span>
|
|
1214
|
+
|
|
1215
|
+
</span>
|
|
1216
|
+
</h4>
|
|
1217
|
+
|
|
1218
|
+
|
|
1219
|
+
|
|
1220
|
+
|
|
1221
|
+
<div class="description">
|
|
1222
|
+
Start process
|
|
1223
|
+
</div>
|
|
1224
|
+
|
|
1225
|
+
|
|
1226
|
+
|
|
1227
|
+
|
|
1228
|
+
|
|
1229
|
+
|
|
1230
|
+
|
|
1231
|
+
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
<h5>Parameters:</h5>
|
|
1235
|
+
|
|
1236
|
+
<div class="table-container">
|
|
1237
|
+
<table class="params table">
|
|
1238
|
+
<thead>
|
|
1239
|
+
<tr>
|
|
1240
|
+
|
|
1241
|
+
<th>Name</th>
|
|
1242
|
+
|
|
1243
|
+
|
|
1244
|
+
<th>Type</th>
|
|
1245
|
+
|
|
1246
|
+
|
|
1247
|
+
<th>Attributes</th>
|
|
1248
|
+
|
|
1249
|
+
|
|
1250
|
+
|
|
1251
|
+
<th>Default</th>
|
|
1252
|
+
|
|
1253
|
+
|
|
1254
|
+
<th class="last">Description</th>
|
|
1255
|
+
</tr>
|
|
1256
|
+
</thead>
|
|
1257
|
+
|
|
1258
|
+
<tbody>
|
|
1259
|
+
|
|
1260
|
+
|
|
1261
|
+
|
|
1262
|
+
<tr class="deep-level-0">
|
|
1263
|
+
|
|
1264
|
+
<td class="name"><code>params</code></td>
|
|
1265
|
+
|
|
1266
|
+
|
|
1267
|
+
<td class="type">
|
|
1268
|
+
|
|
1269
|
+
|
|
1270
|
+
<code class="param-type">object</code>
|
|
1271
|
+
|
|
1272
|
+
|
|
1273
|
+
|
|
1274
|
+
</td>
|
|
1275
|
+
|
|
1276
|
+
|
|
1277
|
+
<td class="attributes">
|
|
1278
|
+
|
|
1279
|
+
|
|
1280
|
+
|
|
1281
|
+
|
|
1282
|
+
|
|
1283
|
+
</td>
|
|
1284
|
+
|
|
1285
|
+
|
|
1286
|
+
|
|
1287
|
+
<td class="default">
|
|
1288
|
+
|
|
1289
|
+
</td>
|
|
1290
|
+
|
|
1291
|
+
|
|
1292
|
+
<td class="description last">Params to start process</td>
|
|
1293
|
+
</tr>
|
|
1294
|
+
|
|
1295
|
+
|
|
1296
|
+
|
|
1297
|
+
|
|
1298
|
+
<tr class="deep-level-1">
|
|
1299
|
+
|
|
1300
|
+
<td class="name"><code>processId</code></td>
|
|
1301
|
+
|
|
1302
|
+
|
|
1303
|
+
<td class="type">
|
|
1304
|
+
|
|
1305
|
+
|
|
1306
|
+
<code class="param-type">string</code>
|
|
1307
|
+
|
|
1308
|
+
|
|
1309
|
+
|
|
1310
|
+
</td>
|
|
1311
|
+
|
|
1312
|
+
|
|
1313
|
+
<td class="attributes">
|
|
1314
|
+
|
|
1315
|
+
|
|
1316
|
+
|
|
1317
|
+
|
|
1318
|
+
|
|
1319
|
+
</td>
|
|
1320
|
+
|
|
1321
|
+
|
|
1322
|
+
|
|
1323
|
+
<td class="default">
|
|
1324
|
+
|
|
1325
|
+
</td>
|
|
1326
|
+
|
|
1327
|
+
|
|
1328
|
+
<td class="description last">Process id (_id database);</td>
|
|
1329
|
+
</tr>
|
|
1330
|
+
|
|
1331
|
+
|
|
1332
|
+
|
|
1333
|
+
<tr class="deep-level-1">
|
|
1334
|
+
|
|
1335
|
+
<td class="name"><code>orgId</code></td>
|
|
1336
|
+
|
|
1337
|
+
|
|
1338
|
+
<td class="type">
|
|
1339
|
+
|
|
1340
|
+
|
|
1341
|
+
<code class="param-type">string</code>
|
|
1342
|
+
|
|
1343
|
+
|
|
1344
|
+
|
|
1345
|
+
</td>
|
|
1346
|
+
|
|
1347
|
+
|
|
1348
|
+
<td class="attributes">
|
|
1349
|
+
|
|
1350
|
+
|
|
1351
|
+
|
|
1352
|
+
|
|
1353
|
+
|
|
1354
|
+
</td>
|
|
1355
|
+
|
|
1356
|
+
|
|
1357
|
+
|
|
1358
|
+
<td class="default">
|
|
1359
|
+
|
|
1360
|
+
</td>
|
|
1361
|
+
|
|
1362
|
+
|
|
1363
|
+
<td class="description last">Organization id (_id database);</td>
|
|
1364
|
+
</tr>
|
|
1365
|
+
|
|
1366
|
+
|
|
1367
|
+
|
|
1368
|
+
<tr class="deep-level-1">
|
|
1369
|
+
|
|
1370
|
+
<td class="name"><code>payload</code></td>
|
|
1371
|
+
|
|
1372
|
+
|
|
1373
|
+
<td class="type">
|
|
1374
|
+
|
|
1375
|
+
|
|
1376
|
+
<code class="param-type">object</code>
|
|
1377
|
+
|
|
1378
|
+
|
|
1379
|
+
|
|
1380
|
+
</td>
|
|
1381
|
+
|
|
1382
|
+
|
|
1383
|
+
<td class="attributes">
|
|
1384
|
+
|
|
1385
|
+
<optional><br>
|
|
1386
|
+
|
|
1387
|
+
|
|
1388
|
+
|
|
1389
|
+
|
|
1390
|
+
|
|
1391
|
+
</td>
|
|
1392
|
+
|
|
1393
|
+
|
|
1394
|
+
|
|
1395
|
+
<td class="default">
|
|
1396
|
+
|
|
1397
|
+
{}
|
|
1398
|
+
|
|
1399
|
+
</td>
|
|
1400
|
+
|
|
1401
|
+
|
|
1402
|
+
<td class="description last">Start process with data</td>
|
|
1403
|
+
</tr>
|
|
1404
|
+
|
|
1405
|
+
|
|
1406
|
+
|
|
1407
|
+
|
|
1408
|
+
|
|
1409
|
+
|
|
1410
|
+
|
|
1411
|
+
<tr class="deep-level-0">
|
|
1412
|
+
|
|
1413
|
+
<td class="name"><code>session</code></td>
|
|
1414
|
+
|
|
1415
|
+
|
|
1416
|
+
<td class="type">
|
|
1417
|
+
|
|
1418
|
+
|
|
1419
|
+
<code class="param-type">string</code>
|
|
1420
|
+
|
|
1421
|
+
|
|
1422
|
+
|
|
1423
|
+
</td>
|
|
1424
|
+
|
|
1425
|
+
|
|
1426
|
+
<td class="attributes">
|
|
1427
|
+
|
|
1428
|
+
|
|
1429
|
+
|
|
1430
|
+
|
|
1431
|
+
|
|
1432
|
+
</td>
|
|
1433
|
+
|
|
1434
|
+
|
|
1435
|
+
|
|
1436
|
+
<td class="default">
|
|
1437
|
+
|
|
1438
|
+
</td>
|
|
1439
|
+
|
|
1440
|
+
|
|
1441
|
+
<td class="description last">Session, token JWT</td>
|
|
1442
|
+
</tr>
|
|
1443
|
+
|
|
1444
|
+
|
|
1445
|
+
|
|
1446
|
+
</tbody>
|
|
1447
|
+
</table>
|
|
1448
|
+
</div>
|
|
1449
|
+
|
|
1450
|
+
|
|
1451
|
+
|
|
1452
|
+
|
|
1453
|
+
|
|
1454
|
+
<dl class="details">
|
|
1455
|
+
|
|
1456
|
+
|
|
1457
|
+
|
|
1458
|
+
|
|
1459
|
+
|
|
1460
|
+
|
|
1461
|
+
|
|
1462
|
+
|
|
1463
|
+
|
|
1464
|
+
|
|
1465
|
+
|
|
1466
|
+
|
|
1467
|
+
|
|
1468
|
+
|
|
1469
|
+
|
|
1470
|
+
|
|
1471
|
+
|
|
1472
|
+
|
|
1473
|
+
<dt class="tag-author">Author:</dt>
|
|
1474
|
+
<dd class="tag-author">
|
|
1475
|
+
<ul>
|
|
1476
|
+
<li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
|
|
1477
|
+
</ul>
|
|
1478
|
+
</dd>
|
|
1479
|
+
|
|
1480
|
+
|
|
1481
|
+
|
|
1482
|
+
|
|
1483
|
+
|
|
1484
|
+
|
|
1485
|
+
|
|
1486
|
+
|
|
1487
|
+
|
|
1488
|
+
|
|
1489
|
+
|
|
1490
|
+
|
|
1491
|
+
|
|
1492
|
+
|
|
1493
|
+
<p class="tag-source">
|
|
1494
|
+
<a href="user_process.js.html" class="button">View Source</a>
|
|
1495
|
+
<span>
|
|
1496
|
+
<a href="user_process.js.html">user/process.js</a>, <a href="user_process.js.html#line90">line 90</a>
|
|
1497
|
+
</span>
|
|
1498
|
+
</p>
|
|
1499
|
+
|
|
1500
|
+
</dl>
|
|
1501
|
+
|
|
1502
|
+
|
|
1503
|
+
|
|
1504
|
+
|
|
1505
|
+
|
|
1506
|
+
|
|
1507
|
+
|
|
1508
|
+
|
|
1509
|
+
|
|
1510
|
+
|
|
1511
|
+
|
|
1512
|
+
|
|
1513
|
+
|
|
1514
|
+
|
|
1515
|
+
|
|
1516
|
+
|
|
1517
|
+
|
|
1518
|
+
|
|
1519
|
+
<div class='columns method-parameter'>
|
|
1520
|
+
<div class="column is-2"><label>Returns:</label></div>
|
|
1521
|
+
<div class="column is-10">
|
|
1522
|
+
|
|
1523
|
+
|
|
1524
|
+
|
|
1525
|
+
<div class="columns">
|
|
1526
|
+
|
|
1527
|
+
|
|
1528
|
+
<div class='column is-5 has-text-left'>
|
|
1529
|
+
<label>Type: </label>
|
|
1530
|
+
|
|
1531
|
+
<code class="param-type">Promise</code>
|
|
1532
|
+
|
|
1533
|
+
|
|
1534
|
+
</div>
|
|
1535
|
+
|
|
1536
|
+
</div>
|
|
1537
|
+
|
|
1538
|
+
|
|
1539
|
+
</div>
|
|
1540
|
+
</div>
|
|
1541
|
+
|
|
1542
|
+
|
|
1543
|
+
|
|
1544
|
+
|
|
1545
|
+
<h5>Example</h5>
|
|
1546
|
+
|
|
1547
|
+
|
|
1548
|
+
<pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
|
|
1549
|
+
const api = new API();
|
|
1550
|
+
const params = {
|
|
1551
|
+
processId: '5dadd01dc4af3941d42f8c5c',
|
|
1552
|
+
orgId: '5edd11c46b6ce9729c2c297c',
|
|
1553
|
+
payload: {}
|
|
1554
|
+
}
|
|
1555
|
+
const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
1556
|
+
await api.user.process.start(params, session);</code></pre>
|
|
1557
|
+
|
|
1558
|
+
|
|
1559
|
+
|
|
1560
|
+
</div>
|
|
1561
|
+
|
|
1562
|
+
</div>
|
|
1563
|
+
</div>
|
|
1564
|
+
|
|
1565
|
+
|
|
1566
|
+
|
|
1567
|
+
|
|
1568
|
+
|
|
1569
|
+
</article>
|
|
1570
|
+
|
|
1571
|
+
</section>
|
|
1572
|
+
|
|
1573
|
+
|
|
1574
|
+
|
|
1575
|
+
|
|
1576
|
+
</div>
|
|
1577
|
+
|
|
1578
|
+
<footer class="footer">
|
|
1579
|
+
<div class="content has-text-centered">
|
|
1580
|
+
<p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a></p>
|
|
1581
|
+
<p class="sidebar-created-by">
|
|
1582
|
+
<a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
|
|
1583
|
+
<a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
|
|
1584
|
+
</p>
|
|
1585
|
+
</div>
|
|
1586
|
+
</footer>
|
|
1587
|
+
|
|
1588
|
+
</div>
|
|
1589
|
+
<div id="side-nav" class="side-nav">
|
|
1590
|
+
</div>
|
|
1591
|
+
</div>
|
|
1592
|
+
<script src="scripts/app.min.js"></script>
|
|
1593
|
+
<script>PR.prettyPrint();</script>
|
|
1594
|
+
<script src="scripts/linenumber.js"> </script>
|
|
1595
|
+
|
|
1596
|
+
|
|
1597
|
+
</body>
|
|
1598
|
+
</html>
|