@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,2235 @@
|
|
|
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> AdminDocuments</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>AdminDocuments</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>AdminDocuments<span class="signature">()</span><span class="type-signature"></span></h2>
|
|
89
|
+
|
|
90
|
+
<div class="class-description">Admin Class for documents, permission admin</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="AdminDocuments">
|
|
110
|
+
<a class="href-link" href="#AdminDocuments">#</a>
|
|
111
|
+
|
|
112
|
+
<span class="code-name">
|
|
113
|
+
|
|
114
|
+
new AdminDocuments<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="admin_document.js.html" class="button">View Source</a>
|
|
169
|
+
<span>
|
|
170
|
+
<a href="admin_document.js.html">admin/document.js</a>, <a href="admin_document.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="advancedSearch">
|
|
228
|
+
<a class="href-link" href="#advancedSearch">#</a>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
<span class='tag'>async</span>
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
<span class="code-name">
|
|
235
|
+
|
|
236
|
+
advancedSearch<span class="signature">(params<span class="signature-attributes">non-null</span>, session<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {Promise}</span>
|
|
237
|
+
|
|
238
|
+
</span>
|
|
239
|
+
</h4>
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
<div class="description">
|
|
245
|
+
Advanced search of document in elastic search ussing system manager
|
|
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 document</td>
|
|
300
|
+
</tr>
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
<tr class="deep-level-1">
|
|
306
|
+
|
|
307
|
+
<td class="name"><code>docId</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">Document id (_id database)</td>
|
|
324
|
+
</tr>
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
<tr class="deep-level-1">
|
|
329
|
+
|
|
330
|
+
<td class="name"><code>query</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">Query to search in elastic search</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="admin_document.js.html" class="button">View Source</a>
|
|
427
|
+
<span>
|
|
428
|
+
<a href="admin_document.js.html">admin/document.js</a>, <a href="admin_document.js.html#line90">line 90</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
|
+
|
|
460
|
+
<div class='column is-5 has-text-left'>
|
|
461
|
+
<label>Type: </label>
|
|
462
|
+
|
|
463
|
+
<code class="param-type">Promise</code>
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
</div>
|
|
467
|
+
|
|
468
|
+
</div>
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
</div>
|
|
472
|
+
</div>
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
<h5>Example</h5>
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
<pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
|
|
481
|
+
const api = new API();
|
|
482
|
+
const params = {
|
|
483
|
+
docId: '5edd11c46b6ce9729c2c297c',
|
|
484
|
+
query: {
|
|
485
|
+
"query": {
|
|
486
|
+
"bool": {
|
|
487
|
+
"minimum_should_match": 1,
|
|
488
|
+
"should": [
|
|
489
|
+
{
|
|
490
|
+
"match": {
|
|
491
|
+
"locationText.keyword": {
|
|
492
|
+
"query": "sao pau"
|
|
493
|
+
}
|
|
494
|
+
}
|
|
495
|
+
},
|
|
496
|
+
{
|
|
497
|
+
"wildcard": {
|
|
498
|
+
"locationText.normalized": "*sao pau*"
|
|
499
|
+
}
|
|
500
|
+
}
|
|
501
|
+
]
|
|
502
|
+
}
|
|
503
|
+
}
|
|
504
|
+
}
|
|
505
|
+
const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
506
|
+
await api.admin.document.advancedSearch(params, session);</code></pre>
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
</div>
|
|
511
|
+
|
|
512
|
+
<div class="member">
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
<h4 class="name" id="findById">
|
|
517
|
+
<a class="href-link" href="#findById">#</a>
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
<span class='tag'>async</span>
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
<span class="code-name">
|
|
524
|
+
|
|
525
|
+
findById<span class="signature">(params, session)</span><span class="type-signature"> → {Promise}</span>
|
|
526
|
+
|
|
527
|
+
</span>
|
|
528
|
+
</h4>
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
<div class="description">
|
|
534
|
+
Get document by id
|
|
535
|
+
</div>
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
<h5>Parameters:</h5>
|
|
547
|
+
|
|
548
|
+
<div class="table-container">
|
|
549
|
+
<table class="params table">
|
|
550
|
+
<thead>
|
|
551
|
+
<tr>
|
|
552
|
+
|
|
553
|
+
<th>Name</th>
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
<th>Type</th>
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
<th class="last">Description</th>
|
|
563
|
+
</tr>
|
|
564
|
+
</thead>
|
|
565
|
+
|
|
566
|
+
<tbody>
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
<tr class="deep-level-0">
|
|
571
|
+
|
|
572
|
+
<td class="name"><code>params</code></td>
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
<td class="type">
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
<code class="param-type">object</code>
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
</td>
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
<td class="description last">Params to get document by id</td>
|
|
589
|
+
</tr>
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
|
|
593
|
+
|
|
594
|
+
<tr class="deep-level-1">
|
|
595
|
+
|
|
596
|
+
<td class="name"><code>docId</code></td>
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
<td class="type">
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
<code class="param-type">string</code>
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
</td>
|
|
607
|
+
|
|
608
|
+
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
<td class="description last">Document id (_id database)</td>
|
|
613
|
+
</tr>
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
<tr class="deep-level-1">
|
|
618
|
+
|
|
619
|
+
<td class="name"><code>orgId</code></td>
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
<td class="type">
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
<code class="param-type">string</code>
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
</td>
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
|
|
635
|
+
<td class="description last">Organization id (_id database)</td>
|
|
636
|
+
</tr>
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
|
|
644
|
+
<tr class="deep-level-0">
|
|
645
|
+
|
|
646
|
+
<td class="name"><code>session</code></td>
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
<td class="type">
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
<code class="param-type">string</code>
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
</td>
|
|
657
|
+
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
<td class="description last">Session, token JWT</td>
|
|
663
|
+
</tr>
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
|
|
667
|
+
</tbody>
|
|
668
|
+
</table>
|
|
669
|
+
</div>
|
|
670
|
+
|
|
671
|
+
|
|
672
|
+
|
|
673
|
+
|
|
674
|
+
|
|
675
|
+
<dl class="details">
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
<dt class="tag-author">Author:</dt>
|
|
695
|
+
<dd class="tag-author">
|
|
696
|
+
<ul>
|
|
697
|
+
<li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
|
|
698
|
+
</ul>
|
|
699
|
+
</dd>
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
<p class="tag-source">
|
|
715
|
+
<a href="admin_document.js.html" class="button">View Source</a>
|
|
716
|
+
<span>
|
|
717
|
+
<a href="admin_document.js.html">admin/document.js</a>, <a href="admin_document.js.html#line130">line 130</a>
|
|
718
|
+
</span>
|
|
719
|
+
</p>
|
|
720
|
+
|
|
721
|
+
</dl>
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
|
|
737
|
+
|
|
738
|
+
|
|
739
|
+
|
|
740
|
+
<div class='columns method-parameter'>
|
|
741
|
+
<div class="column is-2"><label>Returns:</label></div>
|
|
742
|
+
<div class="column is-10">
|
|
743
|
+
|
|
744
|
+
|
|
745
|
+
|
|
746
|
+
<div class="columns">
|
|
747
|
+
|
|
748
|
+
|
|
749
|
+
<div class='column is-5 has-text-left'>
|
|
750
|
+
<label>Type: </label>
|
|
751
|
+
|
|
752
|
+
<code class="param-type">Promise</code>
|
|
753
|
+
|
|
754
|
+
|
|
755
|
+
</div>
|
|
756
|
+
|
|
757
|
+
</div>
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
</div>
|
|
761
|
+
</div>
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
|
|
766
|
+
<h5>Example</h5>
|
|
767
|
+
|
|
768
|
+
|
|
769
|
+
<pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
|
|
770
|
+
const api = new API();
|
|
771
|
+
const params = {
|
|
772
|
+
docId: '5edd11c46b6ce9729c2c297c',
|
|
773
|
+
orgId: '55e4a3bd6be6b45210833fae'
|
|
774
|
+
};
|
|
775
|
+
const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
776
|
+
await api.admin.document.findById(params, session);</code></pre>
|
|
777
|
+
|
|
778
|
+
|
|
779
|
+
|
|
780
|
+
</div>
|
|
781
|
+
|
|
782
|
+
<div class="member">
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
|
|
786
|
+
<h4 class="name" id="getContent">
|
|
787
|
+
<a class="href-link" href="#getContent">#</a>
|
|
788
|
+
|
|
789
|
+
|
|
790
|
+
<span class='tag'>async</span>
|
|
791
|
+
|
|
792
|
+
|
|
793
|
+
<span class="code-name">
|
|
794
|
+
|
|
795
|
+
getContent<span class="signature">(params, apiKey)</span><span class="type-signature"> → {Promise.<object>|string|string|string|string|number}</span>
|
|
796
|
+
|
|
797
|
+
</span>
|
|
798
|
+
</h4>
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
<div class="description">
|
|
804
|
+
Get the content of a document
|
|
805
|
+
</div>
|
|
806
|
+
|
|
807
|
+
|
|
808
|
+
|
|
809
|
+
|
|
810
|
+
|
|
811
|
+
|
|
812
|
+
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
|
|
816
|
+
<h5>Parameters:</h5>
|
|
817
|
+
|
|
818
|
+
<div class="table-container">
|
|
819
|
+
<table class="params table">
|
|
820
|
+
<thead>
|
|
821
|
+
<tr>
|
|
822
|
+
|
|
823
|
+
<th>Name</th>
|
|
824
|
+
|
|
825
|
+
|
|
826
|
+
<th>Type</th>
|
|
827
|
+
|
|
828
|
+
|
|
829
|
+
|
|
830
|
+
|
|
831
|
+
|
|
832
|
+
<th class="last">Description</th>
|
|
833
|
+
</tr>
|
|
834
|
+
</thead>
|
|
835
|
+
|
|
836
|
+
<tbody>
|
|
837
|
+
|
|
838
|
+
|
|
839
|
+
|
|
840
|
+
<tr class="deep-level-0">
|
|
841
|
+
|
|
842
|
+
<td class="name"><code>params</code></td>
|
|
843
|
+
|
|
844
|
+
|
|
845
|
+
<td class="type">
|
|
846
|
+
|
|
847
|
+
|
|
848
|
+
<code class="param-type">object</code>
|
|
849
|
+
|
|
850
|
+
|
|
851
|
+
|
|
852
|
+
</td>
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
|
|
856
|
+
|
|
857
|
+
|
|
858
|
+
<td class="description last">Params to request signed url</td>
|
|
859
|
+
</tr>
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
|
|
864
|
+
<tr class="deep-level-1">
|
|
865
|
+
|
|
866
|
+
<td class="name"><code>docId</code></td>
|
|
867
|
+
|
|
868
|
+
|
|
869
|
+
<td class="type">
|
|
870
|
+
|
|
871
|
+
|
|
872
|
+
<code class="param-type">string</code>
|
|
873
|
+
|
|
874
|
+
|
|
875
|
+
|
|
876
|
+
</td>
|
|
877
|
+
|
|
878
|
+
|
|
879
|
+
|
|
880
|
+
|
|
881
|
+
|
|
882
|
+
<td class="description last">The unique id of the document</td>
|
|
883
|
+
</tr>
|
|
884
|
+
|
|
885
|
+
|
|
886
|
+
|
|
887
|
+
<tr class="deep-level-1">
|
|
888
|
+
|
|
889
|
+
<td class="name"><code>page</code></td>
|
|
890
|
+
|
|
891
|
+
|
|
892
|
+
<td class="type">
|
|
893
|
+
|
|
894
|
+
|
|
895
|
+
<code class="param-type">string</code>
|
|
896
|
+
|
|
897
|
+
|
|
898
|
+
|
|
899
|
+
</td>
|
|
900
|
+
|
|
901
|
+
|
|
902
|
+
|
|
903
|
+
|
|
904
|
+
|
|
905
|
+
<td class="description last">The page, from 0, or 'all' if all pages (the full content)</td>
|
|
906
|
+
</tr>
|
|
907
|
+
|
|
908
|
+
|
|
909
|
+
|
|
910
|
+
|
|
911
|
+
|
|
912
|
+
|
|
913
|
+
|
|
914
|
+
<tr class="deep-level-0">
|
|
915
|
+
|
|
916
|
+
<td class="name"><code>apiKey</code></td>
|
|
917
|
+
|
|
918
|
+
|
|
919
|
+
<td class="type">
|
|
920
|
+
|
|
921
|
+
|
|
922
|
+
<code class="param-type">string</code>
|
|
923
|
+
|
|
924
|
+
|
|
925
|
+
|
|
926
|
+
</td>
|
|
927
|
+
|
|
928
|
+
|
|
929
|
+
|
|
930
|
+
|
|
931
|
+
|
|
932
|
+
<td class="description last">Api Key as permission to use this functionality</td>
|
|
933
|
+
</tr>
|
|
934
|
+
|
|
935
|
+
|
|
936
|
+
|
|
937
|
+
</tbody>
|
|
938
|
+
</table>
|
|
939
|
+
</div>
|
|
940
|
+
|
|
941
|
+
|
|
942
|
+
|
|
943
|
+
|
|
944
|
+
|
|
945
|
+
<dl class="details">
|
|
946
|
+
|
|
947
|
+
|
|
948
|
+
|
|
949
|
+
|
|
950
|
+
|
|
951
|
+
|
|
952
|
+
|
|
953
|
+
|
|
954
|
+
|
|
955
|
+
|
|
956
|
+
|
|
957
|
+
|
|
958
|
+
|
|
959
|
+
|
|
960
|
+
|
|
961
|
+
|
|
962
|
+
|
|
963
|
+
|
|
964
|
+
<dt class="tag-author">Author:</dt>
|
|
965
|
+
<dd class="tag-author">
|
|
966
|
+
<ul>
|
|
967
|
+
<li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
|
|
968
|
+
</ul>
|
|
969
|
+
</dd>
|
|
970
|
+
|
|
971
|
+
|
|
972
|
+
|
|
973
|
+
|
|
974
|
+
|
|
975
|
+
|
|
976
|
+
|
|
977
|
+
|
|
978
|
+
|
|
979
|
+
|
|
980
|
+
|
|
981
|
+
|
|
982
|
+
|
|
983
|
+
|
|
984
|
+
<p class="tag-source">
|
|
985
|
+
<a href="admin_document.js.html" class="button">View Source</a>
|
|
986
|
+
<span>
|
|
987
|
+
<a href="admin_document.js.html">admin/document.js</a>, <a href="admin_document.js.html#line315">line 315</a>
|
|
988
|
+
</span>
|
|
989
|
+
</p>
|
|
990
|
+
|
|
991
|
+
</dl>
|
|
992
|
+
|
|
993
|
+
|
|
994
|
+
|
|
995
|
+
|
|
996
|
+
|
|
997
|
+
|
|
998
|
+
|
|
999
|
+
|
|
1000
|
+
|
|
1001
|
+
|
|
1002
|
+
|
|
1003
|
+
|
|
1004
|
+
|
|
1005
|
+
|
|
1006
|
+
|
|
1007
|
+
|
|
1008
|
+
|
|
1009
|
+
|
|
1010
|
+
<div class='columns method-parameter'>
|
|
1011
|
+
<div class="column is-2"><label>Returns:</label></div>
|
|
1012
|
+
<div class="column is-10">
|
|
1013
|
+
|
|
1014
|
+
|
|
1015
|
+
|
|
1016
|
+
<div class="columns">
|
|
1017
|
+
|
|
1018
|
+
<div class='param-desc column is-7'>data the document content</div>
|
|
1019
|
+
|
|
1020
|
+
|
|
1021
|
+
<div class='column is-5 has-text-left'>
|
|
1022
|
+
<label>Type: </label>
|
|
1023
|
+
|
|
1024
|
+
<code class="param-type">Promise.<object></code>
|
|
1025
|
+
|
|
1026
|
+
|
|
1027
|
+
</div>
|
|
1028
|
+
|
|
1029
|
+
</div>
|
|
1030
|
+
|
|
1031
|
+
|
|
1032
|
+
|
|
1033
|
+
|
|
1034
|
+
<div class="columns">
|
|
1035
|
+
|
|
1036
|
+
<div class='param-desc column is-7'>data._id the _id of the document</div>
|
|
1037
|
+
|
|
1038
|
+
|
|
1039
|
+
<div class='column is-5 has-text-left'>
|
|
1040
|
+
<label>Type: </label>
|
|
1041
|
+
|
|
1042
|
+
<code class="param-type">string</code>
|
|
1043
|
+
|
|
1044
|
+
|
|
1045
|
+
</div>
|
|
1046
|
+
|
|
1047
|
+
</div>
|
|
1048
|
+
|
|
1049
|
+
|
|
1050
|
+
|
|
1051
|
+
|
|
1052
|
+
<div class="columns">
|
|
1053
|
+
|
|
1054
|
+
<div class='param-desc column is-7'>data.content all the pages or if asked by page, just one page, the one requested</div>
|
|
1055
|
+
|
|
1056
|
+
|
|
1057
|
+
<div class='column is-5 has-text-left'>
|
|
1058
|
+
<label>Type: </label>
|
|
1059
|
+
|
|
1060
|
+
<code class="param-type">string</code>
|
|
1061
|
+
|
|
1062
|
+
|
|
1063
|
+
</div>
|
|
1064
|
+
|
|
1065
|
+
</div>
|
|
1066
|
+
|
|
1067
|
+
|
|
1068
|
+
|
|
1069
|
+
|
|
1070
|
+
<div class="columns">
|
|
1071
|
+
|
|
1072
|
+
<div class='param-desc column is-7'>data.content.TextOverlay the overlay text if requested</div>
|
|
1073
|
+
|
|
1074
|
+
|
|
1075
|
+
<div class='column is-5 has-text-left'>
|
|
1076
|
+
<label>Type: </label>
|
|
1077
|
+
|
|
1078
|
+
<code class="param-type">string</code>
|
|
1079
|
+
|
|
1080
|
+
|
|
1081
|
+
</div>
|
|
1082
|
+
|
|
1083
|
+
</div>
|
|
1084
|
+
|
|
1085
|
+
|
|
1086
|
+
|
|
1087
|
+
|
|
1088
|
+
<div class="columns">
|
|
1089
|
+
|
|
1090
|
+
<div class='param-desc column is-7'>data.content.ParsedText the page text content</div>
|
|
1091
|
+
|
|
1092
|
+
|
|
1093
|
+
<div class='column is-5 has-text-left'>
|
|
1094
|
+
<label>Type: </label>
|
|
1095
|
+
|
|
1096
|
+
<code class="param-type">string</code>
|
|
1097
|
+
|
|
1098
|
+
|
|
1099
|
+
</div>
|
|
1100
|
+
|
|
1101
|
+
</div>
|
|
1102
|
+
|
|
1103
|
+
|
|
1104
|
+
|
|
1105
|
+
|
|
1106
|
+
<div class="columns">
|
|
1107
|
+
|
|
1108
|
+
<div class='param-desc column is-7'>data.total the total number of pages</div>
|
|
1109
|
+
|
|
1110
|
+
|
|
1111
|
+
<div class='column is-5 has-text-left'>
|
|
1112
|
+
<label>Type: </label>
|
|
1113
|
+
|
|
1114
|
+
<code class="param-type">number</code>
|
|
1115
|
+
|
|
1116
|
+
|
|
1117
|
+
</div>
|
|
1118
|
+
|
|
1119
|
+
</div>
|
|
1120
|
+
|
|
1121
|
+
|
|
1122
|
+
</div>
|
|
1123
|
+
</div>
|
|
1124
|
+
|
|
1125
|
+
|
|
1126
|
+
|
|
1127
|
+
|
|
1128
|
+
<h5>Example</h5>
|
|
1129
|
+
|
|
1130
|
+
|
|
1131
|
+
<pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
|
|
1132
|
+
const api = new API();
|
|
1133
|
+
const params - {
|
|
1134
|
+
page: '0',
|
|
1135
|
+
docId: '5dadd01dc4af3941d42f8c5c'
|
|
1136
|
+
};
|
|
1137
|
+
const apiKey: '...';
|
|
1138
|
+
await api.admin.document.getContent(params, apiKey);</code></pre>
|
|
1139
|
+
|
|
1140
|
+
|
|
1141
|
+
|
|
1142
|
+
</div>
|
|
1143
|
+
|
|
1144
|
+
<div class="member">
|
|
1145
|
+
|
|
1146
|
+
|
|
1147
|
+
|
|
1148
|
+
<h4 class="name" id="signedUrl">
|
|
1149
|
+
<a class="href-link" href="#signedUrl">#</a>
|
|
1150
|
+
|
|
1151
|
+
|
|
1152
|
+
<span class='tag'>async</span>
|
|
1153
|
+
|
|
1154
|
+
|
|
1155
|
+
<span class="code-name">
|
|
1156
|
+
|
|
1157
|
+
signedUrl<span class="signature">(params, apiKey)</span><span class="type-signature"> → {Promise.<object>|string|string|string|string|string}</span>
|
|
1158
|
+
|
|
1159
|
+
</span>
|
|
1160
|
+
</h4>
|
|
1161
|
+
|
|
1162
|
+
|
|
1163
|
+
|
|
1164
|
+
|
|
1165
|
+
<div class="description">
|
|
1166
|
+
Request signed url url to put or get
|
|
1167
|
+
</div>
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
|
|
1171
|
+
|
|
1172
|
+
|
|
1173
|
+
|
|
1174
|
+
|
|
1175
|
+
|
|
1176
|
+
|
|
1177
|
+
|
|
1178
|
+
<h5>Parameters:</h5>
|
|
1179
|
+
|
|
1180
|
+
<div class="table-container">
|
|
1181
|
+
<table class="params table">
|
|
1182
|
+
<thead>
|
|
1183
|
+
<tr>
|
|
1184
|
+
|
|
1185
|
+
<th>Name</th>
|
|
1186
|
+
|
|
1187
|
+
|
|
1188
|
+
<th>Type</th>
|
|
1189
|
+
|
|
1190
|
+
|
|
1191
|
+
|
|
1192
|
+
|
|
1193
|
+
|
|
1194
|
+
<th class="last">Description</th>
|
|
1195
|
+
</tr>
|
|
1196
|
+
</thead>
|
|
1197
|
+
|
|
1198
|
+
<tbody>
|
|
1199
|
+
|
|
1200
|
+
|
|
1201
|
+
|
|
1202
|
+
<tr class="deep-level-0">
|
|
1203
|
+
|
|
1204
|
+
<td class="name"><code>params</code></td>
|
|
1205
|
+
|
|
1206
|
+
|
|
1207
|
+
<td class="type">
|
|
1208
|
+
|
|
1209
|
+
|
|
1210
|
+
<code class="param-type">object</code>
|
|
1211
|
+
|
|
1212
|
+
|
|
1213
|
+
|
|
1214
|
+
</td>
|
|
1215
|
+
|
|
1216
|
+
|
|
1217
|
+
|
|
1218
|
+
|
|
1219
|
+
|
|
1220
|
+
<td class="description last">Params to request signed url</td>
|
|
1221
|
+
</tr>
|
|
1222
|
+
|
|
1223
|
+
|
|
1224
|
+
|
|
1225
|
+
|
|
1226
|
+
<tr class="deep-level-1">
|
|
1227
|
+
|
|
1228
|
+
<td class="name"><code>methodType</code></td>
|
|
1229
|
+
|
|
1230
|
+
|
|
1231
|
+
<td class="type">
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
<code class="param-type">string</code>
|
|
1235
|
+
|
|
1236
|
+
|
|
1237
|
+
|
|
1238
|
+
</td>
|
|
1239
|
+
|
|
1240
|
+
|
|
1241
|
+
|
|
1242
|
+
|
|
1243
|
+
|
|
1244
|
+
<td class="description last">Method type HTTP get or put</td>
|
|
1245
|
+
</tr>
|
|
1246
|
+
|
|
1247
|
+
|
|
1248
|
+
|
|
1249
|
+
<tr class="deep-level-1">
|
|
1250
|
+
|
|
1251
|
+
<td class="name"><code>docId</code></td>
|
|
1252
|
+
|
|
1253
|
+
|
|
1254
|
+
<td class="type">
|
|
1255
|
+
|
|
1256
|
+
|
|
1257
|
+
<code class="param-type">string</code>
|
|
1258
|
+
|
|
1259
|
+
|
|
1260
|
+
|
|
1261
|
+
</td>
|
|
1262
|
+
|
|
1263
|
+
|
|
1264
|
+
|
|
1265
|
+
|
|
1266
|
+
|
|
1267
|
+
<td class="description last">The unique id of the document</td>
|
|
1268
|
+
</tr>
|
|
1269
|
+
|
|
1270
|
+
|
|
1271
|
+
|
|
1272
|
+
|
|
1273
|
+
|
|
1274
|
+
|
|
1275
|
+
|
|
1276
|
+
<tr class="deep-level-0">
|
|
1277
|
+
|
|
1278
|
+
<td class="name"><code>apiKey</code></td>
|
|
1279
|
+
|
|
1280
|
+
|
|
1281
|
+
<td class="type">
|
|
1282
|
+
|
|
1283
|
+
|
|
1284
|
+
<code class="param-type">string</code>
|
|
1285
|
+
|
|
1286
|
+
|
|
1287
|
+
|
|
1288
|
+
</td>
|
|
1289
|
+
|
|
1290
|
+
|
|
1291
|
+
|
|
1292
|
+
|
|
1293
|
+
|
|
1294
|
+
<td class="description last">Api Key as permission to use this functionality</td>
|
|
1295
|
+
</tr>
|
|
1296
|
+
|
|
1297
|
+
|
|
1298
|
+
|
|
1299
|
+
</tbody>
|
|
1300
|
+
</table>
|
|
1301
|
+
</div>
|
|
1302
|
+
|
|
1303
|
+
|
|
1304
|
+
|
|
1305
|
+
|
|
1306
|
+
|
|
1307
|
+
<dl class="details">
|
|
1308
|
+
|
|
1309
|
+
|
|
1310
|
+
|
|
1311
|
+
|
|
1312
|
+
|
|
1313
|
+
|
|
1314
|
+
|
|
1315
|
+
|
|
1316
|
+
|
|
1317
|
+
|
|
1318
|
+
|
|
1319
|
+
|
|
1320
|
+
|
|
1321
|
+
|
|
1322
|
+
|
|
1323
|
+
|
|
1324
|
+
|
|
1325
|
+
|
|
1326
|
+
<dt class="tag-author">Author:</dt>
|
|
1327
|
+
<dd class="tag-author">
|
|
1328
|
+
<ul>
|
|
1329
|
+
<li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
|
|
1330
|
+
</ul>
|
|
1331
|
+
</dd>
|
|
1332
|
+
|
|
1333
|
+
|
|
1334
|
+
|
|
1335
|
+
|
|
1336
|
+
|
|
1337
|
+
|
|
1338
|
+
|
|
1339
|
+
|
|
1340
|
+
|
|
1341
|
+
|
|
1342
|
+
|
|
1343
|
+
|
|
1344
|
+
|
|
1345
|
+
|
|
1346
|
+
<p class="tag-source">
|
|
1347
|
+
<a href="admin_document.js.html" class="button">View Source</a>
|
|
1348
|
+
<span>
|
|
1349
|
+
<a href="admin_document.js.html">admin/document.js</a>, <a href="admin_document.js.html#line185">line 185</a>
|
|
1350
|
+
</span>
|
|
1351
|
+
</p>
|
|
1352
|
+
|
|
1353
|
+
</dl>
|
|
1354
|
+
|
|
1355
|
+
|
|
1356
|
+
|
|
1357
|
+
|
|
1358
|
+
|
|
1359
|
+
|
|
1360
|
+
|
|
1361
|
+
|
|
1362
|
+
|
|
1363
|
+
|
|
1364
|
+
|
|
1365
|
+
|
|
1366
|
+
|
|
1367
|
+
|
|
1368
|
+
|
|
1369
|
+
|
|
1370
|
+
|
|
1371
|
+
|
|
1372
|
+
<div class='columns method-parameter'>
|
|
1373
|
+
<div class="column is-2"><label>Returns:</label></div>
|
|
1374
|
+
<div class="column is-10">
|
|
1375
|
+
|
|
1376
|
+
|
|
1377
|
+
|
|
1378
|
+
<div class="columns">
|
|
1379
|
+
|
|
1380
|
+
<div class='param-desc column is-7'>doc Returned document data with the signed url</div>
|
|
1381
|
+
|
|
1382
|
+
|
|
1383
|
+
<div class='column is-5 has-text-left'>
|
|
1384
|
+
<label>Type: </label>
|
|
1385
|
+
|
|
1386
|
+
<code class="param-type">Promise.<object></code>
|
|
1387
|
+
|
|
1388
|
+
|
|
1389
|
+
</div>
|
|
1390
|
+
|
|
1391
|
+
</div>
|
|
1392
|
+
|
|
1393
|
+
|
|
1394
|
+
|
|
1395
|
+
|
|
1396
|
+
<div class="columns">
|
|
1397
|
+
|
|
1398
|
+
<div class='param-desc column is-7'>doc.docId Document id</div>
|
|
1399
|
+
|
|
1400
|
+
|
|
1401
|
+
<div class='column is-5 has-text-left'>
|
|
1402
|
+
<label>Type: </label>
|
|
1403
|
+
|
|
1404
|
+
<code class="param-type">string</code>
|
|
1405
|
+
|
|
1406
|
+
|
|
1407
|
+
</div>
|
|
1408
|
+
|
|
1409
|
+
</div>
|
|
1410
|
+
|
|
1411
|
+
|
|
1412
|
+
|
|
1413
|
+
|
|
1414
|
+
<div class="columns">
|
|
1415
|
+
|
|
1416
|
+
<div class='param-desc column is-7'>doc.name The name of the document, which is the fileName</div>
|
|
1417
|
+
|
|
1418
|
+
|
|
1419
|
+
<div class='column is-5 has-text-left'>
|
|
1420
|
+
<label>Type: </label>
|
|
1421
|
+
|
|
1422
|
+
<code class="param-type">string</code>
|
|
1423
|
+
|
|
1424
|
+
|
|
1425
|
+
</div>
|
|
1426
|
+
|
|
1427
|
+
</div>
|
|
1428
|
+
|
|
1429
|
+
|
|
1430
|
+
|
|
1431
|
+
|
|
1432
|
+
<div class="columns">
|
|
1433
|
+
|
|
1434
|
+
<div class='param-desc column is-7'>doc.areaId docAreaId of the document</div>
|
|
1435
|
+
|
|
1436
|
+
|
|
1437
|
+
<div class='column is-5 has-text-left'>
|
|
1438
|
+
<label>Type: </label>
|
|
1439
|
+
|
|
1440
|
+
<code class="param-type">string</code>
|
|
1441
|
+
|
|
1442
|
+
|
|
1443
|
+
</div>
|
|
1444
|
+
|
|
1445
|
+
</div>
|
|
1446
|
+
|
|
1447
|
+
|
|
1448
|
+
|
|
1449
|
+
|
|
1450
|
+
<div class="columns">
|
|
1451
|
+
|
|
1452
|
+
<div class='param-desc column is-7'>doc.type the document mimi type</div>
|
|
1453
|
+
|
|
1454
|
+
|
|
1455
|
+
<div class='column is-5 has-text-left'>
|
|
1456
|
+
<label>Type: </label>
|
|
1457
|
+
|
|
1458
|
+
<code class="param-type">string</code>
|
|
1459
|
+
|
|
1460
|
+
|
|
1461
|
+
</div>
|
|
1462
|
+
|
|
1463
|
+
</div>
|
|
1464
|
+
|
|
1465
|
+
|
|
1466
|
+
|
|
1467
|
+
|
|
1468
|
+
<div class="columns">
|
|
1469
|
+
|
|
1470
|
+
<div class='param-desc column is-7'>doc.signedUrl the signed URL to upload</div>
|
|
1471
|
+
|
|
1472
|
+
|
|
1473
|
+
<div class='column is-5 has-text-left'>
|
|
1474
|
+
<label>Type: </label>
|
|
1475
|
+
|
|
1476
|
+
<code class="param-type">string</code>
|
|
1477
|
+
|
|
1478
|
+
|
|
1479
|
+
</div>
|
|
1480
|
+
|
|
1481
|
+
</div>
|
|
1482
|
+
|
|
1483
|
+
|
|
1484
|
+
</div>
|
|
1485
|
+
</div>
|
|
1486
|
+
|
|
1487
|
+
|
|
1488
|
+
|
|
1489
|
+
|
|
1490
|
+
<h5>Examples</h5>
|
|
1491
|
+
|
|
1492
|
+
|
|
1493
|
+
<pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
|
|
1494
|
+
const api = new API();
|
|
1495
|
+
const params - {
|
|
1496
|
+
methodType: 'put',
|
|
1497
|
+
docId: '5dadd01dc4af3941d42f8c5c'
|
|
1498
|
+
};
|
|
1499
|
+
const apiKey: '...';
|
|
1500
|
+
const { docId, name, areaId, type, signedUrl } = await api.admin.document.signedUrl(params, apiKey);</code></pre>
|
|
1501
|
+
|
|
1502
|
+
|
|
1503
|
+
|
|
1504
|
+
<pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
|
|
1505
|
+
const api = new API();
|
|
1506
|
+
const params - {
|
|
1507
|
+
methodType: 'get',
|
|
1508
|
+
docId: '5dadd01dc4af3941d42f8c5c'
|
|
1509
|
+
};
|
|
1510
|
+
const apiKey: '...';
|
|
1511
|
+
const { signedUrl, imageType } = await api.admin.document.signedUrl(params, apiKey);</code></pre>
|
|
1512
|
+
|
|
1513
|
+
|
|
1514
|
+
|
|
1515
|
+
</div>
|
|
1516
|
+
|
|
1517
|
+
<div class="member">
|
|
1518
|
+
|
|
1519
|
+
|
|
1520
|
+
|
|
1521
|
+
<h4 class="name" id="updateAI">
|
|
1522
|
+
<a class="href-link" href="#updateAI">#</a>
|
|
1523
|
+
|
|
1524
|
+
|
|
1525
|
+
<span class='tag'>async</span>
|
|
1526
|
+
|
|
1527
|
+
|
|
1528
|
+
<span class="code-name">
|
|
1529
|
+
|
|
1530
|
+
updateAI<span class="signature">(params, apiKey)</span><span class="type-signature"> → {Promise.<object>}</span>
|
|
1531
|
+
|
|
1532
|
+
</span>
|
|
1533
|
+
</h4>
|
|
1534
|
+
|
|
1535
|
+
|
|
1536
|
+
|
|
1537
|
+
|
|
1538
|
+
<div class="description">
|
|
1539
|
+
Update a document content
|
|
1540
|
+
</div>
|
|
1541
|
+
|
|
1542
|
+
|
|
1543
|
+
|
|
1544
|
+
|
|
1545
|
+
|
|
1546
|
+
|
|
1547
|
+
|
|
1548
|
+
|
|
1549
|
+
|
|
1550
|
+
|
|
1551
|
+
<h5>Parameters:</h5>
|
|
1552
|
+
|
|
1553
|
+
<div class="table-container">
|
|
1554
|
+
<table class="params table">
|
|
1555
|
+
<thead>
|
|
1556
|
+
<tr>
|
|
1557
|
+
|
|
1558
|
+
<th>Name</th>
|
|
1559
|
+
|
|
1560
|
+
|
|
1561
|
+
<th>Type</th>
|
|
1562
|
+
|
|
1563
|
+
|
|
1564
|
+
|
|
1565
|
+
|
|
1566
|
+
|
|
1567
|
+
<th class="last">Description</th>
|
|
1568
|
+
</tr>
|
|
1569
|
+
</thead>
|
|
1570
|
+
|
|
1571
|
+
<tbody>
|
|
1572
|
+
|
|
1573
|
+
|
|
1574
|
+
|
|
1575
|
+
<tr class="deep-level-0">
|
|
1576
|
+
|
|
1577
|
+
<td class="name"><code>params</code></td>
|
|
1578
|
+
|
|
1579
|
+
|
|
1580
|
+
<td class="type">
|
|
1581
|
+
|
|
1582
|
+
|
|
1583
|
+
<code class="param-type">object</code>
|
|
1584
|
+
|
|
1585
|
+
|
|
1586
|
+
|
|
1587
|
+
</td>
|
|
1588
|
+
|
|
1589
|
+
|
|
1590
|
+
|
|
1591
|
+
|
|
1592
|
+
|
|
1593
|
+
<td class="description last">Params to request signed url</td>
|
|
1594
|
+
</tr>
|
|
1595
|
+
|
|
1596
|
+
|
|
1597
|
+
|
|
1598
|
+
|
|
1599
|
+
<tr class="deep-level-1">
|
|
1600
|
+
|
|
1601
|
+
<td class="name"><code>content</code></td>
|
|
1602
|
+
|
|
1603
|
+
|
|
1604
|
+
<td class="type">
|
|
1605
|
+
|
|
1606
|
+
|
|
1607
|
+
<code class="param-type">string</code>
|
|
1608
|
+
|
|
1609
|
+
|
|
1610
|
+
|
|
1611
|
+
</td>
|
|
1612
|
+
|
|
1613
|
+
|
|
1614
|
+
|
|
1615
|
+
|
|
1616
|
+
|
|
1617
|
+
<td class="description last">The content text</td>
|
|
1618
|
+
</tr>
|
|
1619
|
+
|
|
1620
|
+
|
|
1621
|
+
|
|
1622
|
+
<tr class="deep-level-1">
|
|
1623
|
+
|
|
1624
|
+
<td class="name"><code>docId</code></td>
|
|
1625
|
+
|
|
1626
|
+
|
|
1627
|
+
<td class="type">
|
|
1628
|
+
|
|
1629
|
+
|
|
1630
|
+
<code class="param-type">string</code>
|
|
1631
|
+
|
|
1632
|
+
|
|
1633
|
+
|
|
1634
|
+
</td>
|
|
1635
|
+
|
|
1636
|
+
|
|
1637
|
+
|
|
1638
|
+
|
|
1639
|
+
|
|
1640
|
+
<td class="description last">The unique id of the document</td>
|
|
1641
|
+
</tr>
|
|
1642
|
+
|
|
1643
|
+
|
|
1644
|
+
|
|
1645
|
+
<tr class="deep-level-1">
|
|
1646
|
+
|
|
1647
|
+
<td class="name"><code>searchablePDFURL</code></td>
|
|
1648
|
+
|
|
1649
|
+
|
|
1650
|
+
<td class="type">
|
|
1651
|
+
|
|
1652
|
+
|
|
1653
|
+
<code class="param-type">string</code>
|
|
1654
|
+
|
|
1655
|
+
|
|
1656
|
+
|
|
1657
|
+
</td>
|
|
1658
|
+
|
|
1659
|
+
|
|
1660
|
+
|
|
1661
|
+
|
|
1662
|
+
|
|
1663
|
+
<td class="description last">The searchable PDF Url</td>
|
|
1664
|
+
</tr>
|
|
1665
|
+
|
|
1666
|
+
|
|
1667
|
+
|
|
1668
|
+
<tr class="deep-level-1">
|
|
1669
|
+
|
|
1670
|
+
<td class="name"><code>overlay</code></td>
|
|
1671
|
+
|
|
1672
|
+
|
|
1673
|
+
<td class="type">
|
|
1674
|
+
|
|
1675
|
+
|
|
1676
|
+
<code class="param-type">object</code>
|
|
1677
|
+
|
|
1678
|
+
|
|
1679
|
+
|
|
1680
|
+
</td>
|
|
1681
|
+
|
|
1682
|
+
|
|
1683
|
+
|
|
1684
|
+
|
|
1685
|
+
|
|
1686
|
+
<td class="description last">The overlay information</td>
|
|
1687
|
+
</tr>
|
|
1688
|
+
|
|
1689
|
+
|
|
1690
|
+
|
|
1691
|
+
<tr class="deep-level-1">
|
|
1692
|
+
|
|
1693
|
+
<td class="name"><code>entities</code></td>
|
|
1694
|
+
|
|
1695
|
+
|
|
1696
|
+
<td class="type">
|
|
1697
|
+
|
|
1698
|
+
|
|
1699
|
+
<code class="param-type">array</code>
|
|
1700
|
+
|
|
1701
|
+
|
|
1702
|
+
|
|
1703
|
+
</td>
|
|
1704
|
+
|
|
1705
|
+
|
|
1706
|
+
|
|
1707
|
+
|
|
1708
|
+
|
|
1709
|
+
<td class="description last">The list of entities extracted from the text</td>
|
|
1710
|
+
</tr>
|
|
1711
|
+
|
|
1712
|
+
|
|
1713
|
+
|
|
1714
|
+
<tr class="deep-level-1">
|
|
1715
|
+
|
|
1716
|
+
<td class="name"><code>language</code></td>
|
|
1717
|
+
|
|
1718
|
+
|
|
1719
|
+
<td class="type">
|
|
1720
|
+
|
|
1721
|
+
|
|
1722
|
+
<code class="param-type">object</code>
|
|
1723
|
+
|
|
1724
|
+
|
|
1725
|
+
|
|
1726
|
+
</td>
|
|
1727
|
+
|
|
1728
|
+
|
|
1729
|
+
|
|
1730
|
+
|
|
1731
|
+
|
|
1732
|
+
<td class="description last">The language detected</td>
|
|
1733
|
+
</tr>
|
|
1734
|
+
|
|
1735
|
+
|
|
1736
|
+
|
|
1737
|
+
<tr class="deep-level-1">
|
|
1738
|
+
|
|
1739
|
+
<td class="name"><code>language.name</code></td>
|
|
1740
|
+
|
|
1741
|
+
|
|
1742
|
+
<td class="type">
|
|
1743
|
+
|
|
1744
|
+
|
|
1745
|
+
<code class="param-type">string</code>
|
|
1746
|
+
|
|
1747
|
+
|
|
1748
|
+
|
|
1749
|
+
</td>
|
|
1750
|
+
|
|
1751
|
+
|
|
1752
|
+
|
|
1753
|
+
|
|
1754
|
+
|
|
1755
|
+
<td class="description last">The language name detected</td>
|
|
1756
|
+
</tr>
|
|
1757
|
+
|
|
1758
|
+
|
|
1759
|
+
|
|
1760
|
+
<tr class="deep-level-1">
|
|
1761
|
+
|
|
1762
|
+
<td class="name"><code>language.confidence</code></td>
|
|
1763
|
+
|
|
1764
|
+
|
|
1765
|
+
<td class="type">
|
|
1766
|
+
|
|
1767
|
+
|
|
1768
|
+
<code class="param-type">string</code>
|
|
1769
|
+
|
|
1770
|
+
|
|
1771
|
+
|
|
1772
|
+
</td>
|
|
1773
|
+
|
|
1774
|
+
|
|
1775
|
+
|
|
1776
|
+
|
|
1777
|
+
|
|
1778
|
+
<td class="description last">The confidence that it is the language</td>
|
|
1779
|
+
</tr>
|
|
1780
|
+
|
|
1781
|
+
|
|
1782
|
+
|
|
1783
|
+
|
|
1784
|
+
|
|
1785
|
+
|
|
1786
|
+
|
|
1787
|
+
<tr class="deep-level-0">
|
|
1788
|
+
|
|
1789
|
+
<td class="name"><code>apiKey</code></td>
|
|
1790
|
+
|
|
1791
|
+
|
|
1792
|
+
<td class="type">
|
|
1793
|
+
|
|
1794
|
+
|
|
1795
|
+
<code class="param-type">string</code>
|
|
1796
|
+
|
|
1797
|
+
|
|
1798
|
+
|
|
1799
|
+
</td>
|
|
1800
|
+
|
|
1801
|
+
|
|
1802
|
+
|
|
1803
|
+
|
|
1804
|
+
|
|
1805
|
+
<td class="description last">Api Key as permission to use this functionality</td>
|
|
1806
|
+
</tr>
|
|
1807
|
+
|
|
1808
|
+
|
|
1809
|
+
|
|
1810
|
+
</tbody>
|
|
1811
|
+
</table>
|
|
1812
|
+
</div>
|
|
1813
|
+
|
|
1814
|
+
|
|
1815
|
+
|
|
1816
|
+
|
|
1817
|
+
|
|
1818
|
+
<dl class="details">
|
|
1819
|
+
|
|
1820
|
+
|
|
1821
|
+
|
|
1822
|
+
|
|
1823
|
+
|
|
1824
|
+
|
|
1825
|
+
|
|
1826
|
+
|
|
1827
|
+
|
|
1828
|
+
|
|
1829
|
+
|
|
1830
|
+
|
|
1831
|
+
|
|
1832
|
+
|
|
1833
|
+
|
|
1834
|
+
|
|
1835
|
+
|
|
1836
|
+
|
|
1837
|
+
<dt class="tag-author">Author:</dt>
|
|
1838
|
+
<dd class="tag-author">
|
|
1839
|
+
<ul>
|
|
1840
|
+
<li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
|
|
1841
|
+
</ul>
|
|
1842
|
+
</dd>
|
|
1843
|
+
|
|
1844
|
+
|
|
1845
|
+
|
|
1846
|
+
|
|
1847
|
+
|
|
1848
|
+
|
|
1849
|
+
|
|
1850
|
+
|
|
1851
|
+
|
|
1852
|
+
|
|
1853
|
+
|
|
1854
|
+
|
|
1855
|
+
|
|
1856
|
+
|
|
1857
|
+
<p class="tag-source">
|
|
1858
|
+
<a href="admin_document.js.html" class="button">View Source</a>
|
|
1859
|
+
<span>
|
|
1860
|
+
<a href="admin_document.js.html">admin/document.js</a>, <a href="admin_document.js.html#line270">line 270</a>
|
|
1861
|
+
</span>
|
|
1862
|
+
</p>
|
|
1863
|
+
|
|
1864
|
+
</dl>
|
|
1865
|
+
|
|
1866
|
+
|
|
1867
|
+
|
|
1868
|
+
|
|
1869
|
+
|
|
1870
|
+
|
|
1871
|
+
|
|
1872
|
+
|
|
1873
|
+
|
|
1874
|
+
|
|
1875
|
+
|
|
1876
|
+
|
|
1877
|
+
|
|
1878
|
+
|
|
1879
|
+
|
|
1880
|
+
|
|
1881
|
+
|
|
1882
|
+
|
|
1883
|
+
<div class='columns method-parameter'>
|
|
1884
|
+
<div class="column is-2"><label>Returns:</label></div>
|
|
1885
|
+
<div class="column is-10">
|
|
1886
|
+
|
|
1887
|
+
|
|
1888
|
+
|
|
1889
|
+
<div class="columns">
|
|
1890
|
+
|
|
1891
|
+
<div class='param-desc column is-7'>doc Returned document data with the signed url</div>
|
|
1892
|
+
|
|
1893
|
+
|
|
1894
|
+
<div class='column is-5 has-text-left'>
|
|
1895
|
+
<label>Type: </label>
|
|
1896
|
+
|
|
1897
|
+
<code class="param-type">Promise.<object></code>
|
|
1898
|
+
|
|
1899
|
+
|
|
1900
|
+
</div>
|
|
1901
|
+
|
|
1902
|
+
</div>
|
|
1903
|
+
|
|
1904
|
+
|
|
1905
|
+
</div>
|
|
1906
|
+
</div>
|
|
1907
|
+
|
|
1908
|
+
|
|
1909
|
+
|
|
1910
|
+
|
|
1911
|
+
<h5>Example</h5>
|
|
1912
|
+
|
|
1913
|
+
|
|
1914
|
+
<pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
|
|
1915
|
+
const api = new API();
|
|
1916
|
+
const params - {
|
|
1917
|
+
content: 'some text...',
|
|
1918
|
+
docId: '5dadd01dc4af3941d42f8c5c'
|
|
1919
|
+
};
|
|
1920
|
+
const apiKey: '...';
|
|
1921
|
+
await api.admin.document.updateContent(params, apiKey);</code></pre>
|
|
1922
|
+
|
|
1923
|
+
|
|
1924
|
+
|
|
1925
|
+
</div>
|
|
1926
|
+
|
|
1927
|
+
<div class="member">
|
|
1928
|
+
|
|
1929
|
+
|
|
1930
|
+
|
|
1931
|
+
<h4 class="name" id="updateContent">
|
|
1932
|
+
<a class="href-link" href="#updateContent">#</a>
|
|
1933
|
+
|
|
1934
|
+
|
|
1935
|
+
<span class='tag'>async</span>
|
|
1936
|
+
|
|
1937
|
+
|
|
1938
|
+
<span class="code-name">
|
|
1939
|
+
|
|
1940
|
+
updateContent<span class="signature">(params, apiKey)</span><span class="type-signature"> → {Promise.<object>}</span>
|
|
1941
|
+
|
|
1942
|
+
</span>
|
|
1943
|
+
</h4>
|
|
1944
|
+
|
|
1945
|
+
|
|
1946
|
+
|
|
1947
|
+
|
|
1948
|
+
<div class="description">
|
|
1949
|
+
Update a document content
|
|
1950
|
+
</div>
|
|
1951
|
+
|
|
1952
|
+
|
|
1953
|
+
|
|
1954
|
+
|
|
1955
|
+
|
|
1956
|
+
|
|
1957
|
+
|
|
1958
|
+
|
|
1959
|
+
|
|
1960
|
+
|
|
1961
|
+
<h5>Parameters:</h5>
|
|
1962
|
+
|
|
1963
|
+
<div class="table-container">
|
|
1964
|
+
<table class="params table">
|
|
1965
|
+
<thead>
|
|
1966
|
+
<tr>
|
|
1967
|
+
|
|
1968
|
+
<th>Name</th>
|
|
1969
|
+
|
|
1970
|
+
|
|
1971
|
+
<th>Type</th>
|
|
1972
|
+
|
|
1973
|
+
|
|
1974
|
+
|
|
1975
|
+
|
|
1976
|
+
|
|
1977
|
+
<th class="last">Description</th>
|
|
1978
|
+
</tr>
|
|
1979
|
+
</thead>
|
|
1980
|
+
|
|
1981
|
+
<tbody>
|
|
1982
|
+
|
|
1983
|
+
|
|
1984
|
+
|
|
1985
|
+
<tr class="deep-level-0">
|
|
1986
|
+
|
|
1987
|
+
<td class="name"><code>params</code></td>
|
|
1988
|
+
|
|
1989
|
+
|
|
1990
|
+
<td class="type">
|
|
1991
|
+
|
|
1992
|
+
|
|
1993
|
+
<code class="param-type">object</code>
|
|
1994
|
+
|
|
1995
|
+
|
|
1996
|
+
|
|
1997
|
+
</td>
|
|
1998
|
+
|
|
1999
|
+
|
|
2000
|
+
|
|
2001
|
+
|
|
2002
|
+
|
|
2003
|
+
<td class="description last">Params to request signed url</td>
|
|
2004
|
+
</tr>
|
|
2005
|
+
|
|
2006
|
+
|
|
2007
|
+
|
|
2008
|
+
|
|
2009
|
+
<tr class="deep-level-1">
|
|
2010
|
+
|
|
2011
|
+
<td class="name"><code>content</code></td>
|
|
2012
|
+
|
|
2013
|
+
|
|
2014
|
+
<td class="type">
|
|
2015
|
+
|
|
2016
|
+
|
|
2017
|
+
<code class="param-type">string</code>
|
|
2018
|
+
|
|
2019
|
+
|
|
2020
|
+
|
|
2021
|
+
</td>
|
|
2022
|
+
|
|
2023
|
+
|
|
2024
|
+
|
|
2025
|
+
|
|
2026
|
+
|
|
2027
|
+
<td class="description last">The content text</td>
|
|
2028
|
+
</tr>
|
|
2029
|
+
|
|
2030
|
+
|
|
2031
|
+
|
|
2032
|
+
<tr class="deep-level-1">
|
|
2033
|
+
|
|
2034
|
+
<td class="name"><code>docId</code></td>
|
|
2035
|
+
|
|
2036
|
+
|
|
2037
|
+
<td class="type">
|
|
2038
|
+
|
|
2039
|
+
|
|
2040
|
+
<code class="param-type">string</code>
|
|
2041
|
+
|
|
2042
|
+
|
|
2043
|
+
|
|
2044
|
+
</td>
|
|
2045
|
+
|
|
2046
|
+
|
|
2047
|
+
|
|
2048
|
+
|
|
2049
|
+
|
|
2050
|
+
<td class="description last">The unique id of the document</td>
|
|
2051
|
+
</tr>
|
|
2052
|
+
|
|
2053
|
+
|
|
2054
|
+
|
|
2055
|
+
|
|
2056
|
+
|
|
2057
|
+
|
|
2058
|
+
|
|
2059
|
+
<tr class="deep-level-0">
|
|
2060
|
+
|
|
2061
|
+
<td class="name"><code>apiKey</code></td>
|
|
2062
|
+
|
|
2063
|
+
|
|
2064
|
+
<td class="type">
|
|
2065
|
+
|
|
2066
|
+
|
|
2067
|
+
<code class="param-type">string</code>
|
|
2068
|
+
|
|
2069
|
+
|
|
2070
|
+
|
|
2071
|
+
</td>
|
|
2072
|
+
|
|
2073
|
+
|
|
2074
|
+
|
|
2075
|
+
|
|
2076
|
+
|
|
2077
|
+
<td class="description last">Api Key as permission to use this functionality</td>
|
|
2078
|
+
</tr>
|
|
2079
|
+
|
|
2080
|
+
|
|
2081
|
+
|
|
2082
|
+
</tbody>
|
|
2083
|
+
</table>
|
|
2084
|
+
</div>
|
|
2085
|
+
|
|
2086
|
+
|
|
2087
|
+
|
|
2088
|
+
|
|
2089
|
+
|
|
2090
|
+
<dl class="details">
|
|
2091
|
+
|
|
2092
|
+
|
|
2093
|
+
|
|
2094
|
+
|
|
2095
|
+
|
|
2096
|
+
|
|
2097
|
+
|
|
2098
|
+
|
|
2099
|
+
|
|
2100
|
+
|
|
2101
|
+
|
|
2102
|
+
|
|
2103
|
+
|
|
2104
|
+
|
|
2105
|
+
|
|
2106
|
+
|
|
2107
|
+
|
|
2108
|
+
|
|
2109
|
+
<dt class="tag-author">Author:</dt>
|
|
2110
|
+
<dd class="tag-author">
|
|
2111
|
+
<ul>
|
|
2112
|
+
<li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
|
|
2113
|
+
</ul>
|
|
2114
|
+
</dd>
|
|
2115
|
+
|
|
2116
|
+
|
|
2117
|
+
|
|
2118
|
+
|
|
2119
|
+
|
|
2120
|
+
|
|
2121
|
+
|
|
2122
|
+
|
|
2123
|
+
|
|
2124
|
+
|
|
2125
|
+
|
|
2126
|
+
|
|
2127
|
+
|
|
2128
|
+
|
|
2129
|
+
<p class="tag-source">
|
|
2130
|
+
<a href="admin_document.js.html" class="button">View Source</a>
|
|
2131
|
+
<span>
|
|
2132
|
+
<a href="admin_document.js.html">admin/document.js</a>, <a href="admin_document.js.html#line223">line 223</a>
|
|
2133
|
+
</span>
|
|
2134
|
+
</p>
|
|
2135
|
+
|
|
2136
|
+
</dl>
|
|
2137
|
+
|
|
2138
|
+
|
|
2139
|
+
|
|
2140
|
+
|
|
2141
|
+
|
|
2142
|
+
|
|
2143
|
+
|
|
2144
|
+
|
|
2145
|
+
|
|
2146
|
+
|
|
2147
|
+
|
|
2148
|
+
|
|
2149
|
+
|
|
2150
|
+
|
|
2151
|
+
|
|
2152
|
+
|
|
2153
|
+
|
|
2154
|
+
|
|
2155
|
+
<div class='columns method-parameter'>
|
|
2156
|
+
<div class="column is-2"><label>Returns:</label></div>
|
|
2157
|
+
<div class="column is-10">
|
|
2158
|
+
|
|
2159
|
+
|
|
2160
|
+
|
|
2161
|
+
<div class="columns">
|
|
2162
|
+
|
|
2163
|
+
<div class='param-desc column is-7'>doc Returned document data with the signed url</div>
|
|
2164
|
+
|
|
2165
|
+
|
|
2166
|
+
<div class='column is-5 has-text-left'>
|
|
2167
|
+
<label>Type: </label>
|
|
2168
|
+
|
|
2169
|
+
<code class="param-type">Promise.<object></code>
|
|
2170
|
+
|
|
2171
|
+
|
|
2172
|
+
</div>
|
|
2173
|
+
|
|
2174
|
+
</div>
|
|
2175
|
+
|
|
2176
|
+
|
|
2177
|
+
</div>
|
|
2178
|
+
</div>
|
|
2179
|
+
|
|
2180
|
+
|
|
2181
|
+
|
|
2182
|
+
|
|
2183
|
+
<h5>Example</h5>
|
|
2184
|
+
|
|
2185
|
+
|
|
2186
|
+
<pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
|
|
2187
|
+
const api = new API();
|
|
2188
|
+
const params - {
|
|
2189
|
+
content: 'some text...',
|
|
2190
|
+
docId: '5dadd01dc4af3941d42f8c5c'
|
|
2191
|
+
};
|
|
2192
|
+
const apiKey: '...';
|
|
2193
|
+
await api.admin.document.updateContent(params, apiKey);</code></pre>
|
|
2194
|
+
|
|
2195
|
+
|
|
2196
|
+
|
|
2197
|
+
</div>
|
|
2198
|
+
|
|
2199
|
+
</div>
|
|
2200
|
+
</div>
|
|
2201
|
+
|
|
2202
|
+
|
|
2203
|
+
|
|
2204
|
+
|
|
2205
|
+
|
|
2206
|
+
</article>
|
|
2207
|
+
|
|
2208
|
+
</section>
|
|
2209
|
+
|
|
2210
|
+
|
|
2211
|
+
|
|
2212
|
+
|
|
2213
|
+
</div>
|
|
2214
|
+
|
|
2215
|
+
<footer class="footer">
|
|
2216
|
+
<div class="content has-text-centered">
|
|
2217
|
+
<p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a></p>
|
|
2218
|
+
<p class="sidebar-created-by">
|
|
2219
|
+
<a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
|
|
2220
|
+
<a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
|
|
2221
|
+
</p>
|
|
2222
|
+
</div>
|
|
2223
|
+
</footer>
|
|
2224
|
+
|
|
2225
|
+
</div>
|
|
2226
|
+
<div id="side-nav" class="side-nav">
|
|
2227
|
+
</div>
|
|
2228
|
+
</div>
|
|
2229
|
+
<script src="scripts/app.min.js"></script>
|
|
2230
|
+
<script>PR.prettyPrint();</script>
|
|
2231
|
+
<script src="scripts/linenumber.js"> </script>
|
|
2232
|
+
|
|
2233
|
+
|
|
2234
|
+
</body>
|
|
2235
|
+
</html>
|