@docbrasil/api-systemmanager 1.0.112 → 1.0.113

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/docs/Process.html CHANGED
@@ -224,8 +224,8 @@
224
224
 
225
225
 
226
226
 
227
- <h4 class="name" id="find">
228
- <a class="href-link" href="#find">#</a>
227
+ <h4 class="name" id="exportProcessData">
228
+ <a class="href-link" href="#exportProcessData">#</a>
229
229
 
230
230
 
231
231
  <span class='tag'>async</span>
@@ -233,7 +233,7 @@
233
233
 
234
234
  <span class="code-name">
235
235
 
236
- find<span class="signature">(params, session)</span><span class="type-signature"> &rarr; {promise|number|array.&lt;object>|number|number}</span>
236
+ exportProcessData<span class="signature">(params, session)</span><span class="type-signature"></span>
237
237
 
238
238
  </span>
239
239
  </h4>
@@ -242,7 +242,7 @@
242
242
 
243
243
 
244
244
  <div class="description">
245
- Method to search processes
245
+ Method to export process data
246
246
  </div>
247
247
 
248
248
 
@@ -296,7 +296,254 @@
296
296
 
297
297
 
298
298
 
299
- <td class="description last">Params to search processes</td>
299
+ <td class="description last">Params to export process data</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#line329">line 329</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
+
452
+
453
+
454
+ <h5>Example</h5>
455
+
456
+
457
+ <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
458
+ const api = new API();
459
+ const params = {
460
+ query: {"orgProcessId": {"value":"62c2d1cdfb5455c195d1baa1","oper":"=","type":"string"},"s":[{"historyBegin":{"order":"desc"}}],"i":1,"p":20},
461
+ orgId: '55e4a3bd6be6b45210833fae',
462
+ };
463
+ const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
464
+ const retSearch = await api.user.process.exportProcessData(params, session);</code></pre>
465
+
466
+
467
+
468
+ </div>
469
+
470
+ <div class="member">
471
+
472
+
473
+
474
+ <h4 class="name" id="exportStatusData">
475
+ <a class="href-link" href="#exportStatusData">#</a>
476
+
477
+
478
+ <span class='tag'>async</span>
479
+
480
+
481
+ <span class="code-name">
482
+
483
+ exportStatusData<span class="signature">(params, session)</span><span class="type-signature"></span>
484
+
485
+ </span>
486
+ </h4>
487
+
488
+
489
+
490
+
491
+ <div class="description">
492
+ Method to export status data
493
+ </div>
494
+
495
+
496
+
497
+
498
+
499
+
500
+
501
+
502
+
503
+
504
+ <h5>Parameters:</h5>
505
+
506
+ <div class="table-container">
507
+ <table class="params table">
508
+ <thead>
509
+ <tr>
510
+
511
+ <th>Name</th>
512
+
513
+
514
+ <th>Type</th>
515
+
516
+
517
+
518
+
519
+
520
+ <th class="last">Description</th>
521
+ </tr>
522
+ </thead>
523
+
524
+ <tbody>
525
+
526
+
527
+
528
+ <tr class="deep-level-0">
529
+
530
+ <td class="name"><code>params</code></td>
531
+
532
+
533
+ <td class="type">
534
+
535
+
536
+ <code class="param-type">object</code>
537
+
538
+
539
+
540
+ </td>
541
+
542
+
543
+
544
+
545
+
546
+ <td class="description last">Params to export status data</td>
300
547
  </tr>
301
548
 
302
549
 
@@ -310,7 +557,961 @@
310
557
  <td class="type">
311
558
 
312
559
 
313
- <code class="param-type">object</code>
560
+ <code class="param-type">object</code>
561
+
562
+
563
+
564
+ </td>
565
+
566
+
567
+
568
+
569
+
570
+ <td class="description last">Search process query</td>
571
+ </tr>
572
+
573
+
574
+
575
+ <tr class="deep-level-1">
576
+
577
+ <td class="name"><code>orgId</code></td>
578
+
579
+
580
+ <td class="type">
581
+
582
+
583
+ <code class="param-type">object</code>
584
+
585
+
586
+
587
+ </td>
588
+
589
+
590
+
591
+
592
+
593
+ <td class="description last">Organization id (_id database)</td>
594
+ </tr>
595
+
596
+
597
+
598
+
599
+
600
+
601
+
602
+ <tr class="deep-level-0">
603
+
604
+ <td class="name"><code>session</code></td>
605
+
606
+
607
+ <td class="type">
608
+
609
+
610
+ <code class="param-type">string</code>
611
+
612
+
613
+
614
+ </td>
615
+
616
+
617
+
618
+
619
+
620
+ <td class="description last">Session, token JWT</td>
621
+ </tr>
622
+
623
+
624
+
625
+ </tbody>
626
+ </table>
627
+ </div>
628
+
629
+
630
+
631
+
632
+
633
+ <dl class="details">
634
+
635
+
636
+
637
+
638
+
639
+
640
+
641
+
642
+
643
+
644
+
645
+
646
+
647
+
648
+
649
+
650
+
651
+
652
+ <dt class="tag-author">Author:</dt>
653
+ <dd class="tag-author">
654
+ <ul>
655
+ <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
656
+ </ul>
657
+ </dd>
658
+
659
+
660
+
661
+
662
+
663
+
664
+
665
+
666
+
667
+
668
+
669
+
670
+
671
+
672
+ <p class="tag-source">
673
+ <a href="user_process.js.html" class="button">View Source</a>
674
+ <span>
675
+ <a href="user_process.js.html">user/process.js</a>, <a href="user_process.js.html#line290">line 290</a>
676
+ </span>
677
+ </p>
678
+
679
+ </dl>
680
+
681
+
682
+
683
+
684
+
685
+
686
+
687
+
688
+
689
+
690
+
691
+
692
+
693
+
694
+
695
+
696
+
697
+
698
+
699
+
700
+
701
+ <h5>Example</h5>
702
+
703
+
704
+ <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
705
+ const api = new API();
706
+ const params = {
707
+ query: {"orgProcessId": {"value":"62c2d1cdfb5455c195d1baa1","oper":"=","type":"string"},"s":[{"historyBegin":{"order":"desc"}}],"i":1,"p":20},
708
+ orgId: '55e4a3bd6be6b45210833fae',
709
+ };
710
+ const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
711
+ const retSearch = await api.user.process.exportStatusData(params, session);</code></pre>
712
+
713
+
714
+
715
+ </div>
716
+
717
+ <div class="member">
718
+
719
+
720
+
721
+ <h4 class="name" id="find">
722
+ <a class="href-link" href="#find">#</a>
723
+
724
+
725
+ <span class='tag'>async</span>
726
+
727
+
728
+ <span class="code-name">
729
+
730
+ find<span class="signature">(params, session)</span><span class="type-signature"> &rarr; {promise|number|array.&lt;object>|number|number}</span>
731
+
732
+ </span>
733
+ </h4>
734
+
735
+
736
+
737
+
738
+ <div class="description">
739
+ Method to search processes
740
+ </div>
741
+
742
+
743
+
744
+
745
+
746
+
747
+
748
+
749
+
750
+
751
+ <h5>Parameters:</h5>
752
+
753
+ <div class="table-container">
754
+ <table class="params table">
755
+ <thead>
756
+ <tr>
757
+
758
+ <th>Name</th>
759
+
760
+
761
+ <th>Type</th>
762
+
763
+
764
+
765
+
766
+
767
+ <th class="last">Description</th>
768
+ </tr>
769
+ </thead>
770
+
771
+ <tbody>
772
+
773
+
774
+
775
+ <tr class="deep-level-0">
776
+
777
+ <td class="name"><code>params</code></td>
778
+
779
+
780
+ <td class="type">
781
+
782
+
783
+ <code class="param-type">object</code>
784
+
785
+
786
+
787
+ </td>
788
+
789
+
790
+
791
+
792
+
793
+ <td class="description last">Params to search processes</td>
794
+ </tr>
795
+
796
+
797
+
798
+
799
+ <tr class="deep-level-1">
800
+
801
+ <td class="name"><code>query</code></td>
802
+
803
+
804
+ <td class="type">
805
+
806
+
807
+ <code class="param-type">object</code>
808
+
809
+
810
+
811
+ </td>
812
+
813
+
814
+
815
+
816
+
817
+ <td class="description last">Search process query</td>
818
+ </tr>
819
+
820
+
821
+
822
+ <tr class="deep-level-1">
823
+
824
+ <td class="name"><code>orgId</code></td>
825
+
826
+
827
+ <td class="type">
828
+
829
+
830
+ <code class="param-type">object</code>
831
+
832
+
833
+
834
+ </td>
835
+
836
+
837
+
838
+
839
+
840
+ <td class="description last">Organization id (_id database)</td>
841
+ </tr>
842
+
843
+
844
+
845
+
846
+
847
+
848
+
849
+ <tr class="deep-level-0">
850
+
851
+ <td class="name"><code>session</code></td>
852
+
853
+
854
+ <td class="type">
855
+
856
+
857
+ <code class="param-type">string</code>
858
+
859
+
860
+
861
+ </td>
862
+
863
+
864
+
865
+
866
+
867
+ <td class="description last">Session, token JWT</td>
868
+ </tr>
869
+
870
+
871
+
872
+ </tbody>
873
+ </table>
874
+ </div>
875
+
876
+
877
+
878
+
879
+
880
+ <dl class="details">
881
+
882
+
883
+
884
+
885
+
886
+
887
+
888
+
889
+
890
+
891
+
892
+
893
+
894
+
895
+
896
+
897
+
898
+
899
+ <dt class="tag-author">Author:</dt>
900
+ <dd class="tag-author">
901
+ <ul>
902
+ <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
903
+ </ul>
904
+ </dd>
905
+
906
+
907
+
908
+
909
+
910
+
911
+
912
+
913
+
914
+
915
+
916
+
917
+
918
+
919
+ <p class="tag-source">
920
+ <a href="user_process.js.html" class="button">View Source</a>
921
+ <span>
922
+ <a href="user_process.js.html">user/process.js</a>, <a href="user_process.js.html#line214">line 214</a>
923
+ </span>
924
+ </p>
925
+
926
+ </dl>
927
+
928
+
929
+
930
+
931
+
932
+
933
+
934
+
935
+
936
+
937
+
938
+
939
+
940
+
941
+
942
+
943
+
944
+
945
+ <div class='columns method-parameter'>
946
+ <div class="column is-2"><label>Returns:</label></div>
947
+ <div class="column is-10">
948
+
949
+
950
+
951
+ <div class="columns">
952
+
953
+ <div class='param-desc column is-7'>returned data from the search</div>
954
+
955
+
956
+ <div class='column is-5 has-text-left'>
957
+ <label>Type: </label>
958
+
959
+ <code class="param-type">promise</code>
960
+
961
+
962
+ </div>
963
+
964
+ </div>
965
+
966
+
967
+
968
+
969
+ <div class="columns">
970
+
971
+ <div class='param-desc column is-7'>count the count of items searched</div>
972
+
973
+
974
+ <div class='column is-5 has-text-left'>
975
+ <label>Type: </label>
976
+
977
+ <code class="param-type">number</code>
978
+
979
+
980
+ </div>
981
+
982
+ </div>
983
+
984
+
985
+
986
+
987
+ <div class="columns">
988
+
989
+ <div class='param-desc column is-7'>items the items returned from search</div>
990
+
991
+
992
+ <div class='column is-5 has-text-left'>
993
+ <label>Type: </label>
994
+
995
+ <code class="param-type">array.&lt;object></code>
996
+
997
+
998
+ </div>
999
+
1000
+ </div>
1001
+
1002
+
1003
+
1004
+
1005
+ <div class="columns">
1006
+
1007
+ <div class='param-desc column is-7'>page the page of the search (on pagination), zero indexed</div>
1008
+
1009
+
1010
+ <div class='column is-5 has-text-left'>
1011
+ <label>Type: </label>
1012
+
1013
+ <code class="param-type">number</code>
1014
+
1015
+
1016
+ </div>
1017
+
1018
+ </div>
1019
+
1020
+
1021
+
1022
+
1023
+ <div class="columns">
1024
+
1025
+ <div class='param-desc column is-7'>perPage how many items per page</div>
1026
+
1027
+
1028
+ <div class='column is-5 has-text-left'>
1029
+ <label>Type: </label>
1030
+
1031
+ <code class="param-type">number</code>
1032
+
1033
+
1034
+ </div>
1035
+
1036
+ </div>
1037
+
1038
+
1039
+ </div>
1040
+ </div>
1041
+
1042
+
1043
+
1044
+
1045
+ <h5>Example</h5>
1046
+
1047
+
1048
+ <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
1049
+ const api = new API();
1050
+ const params = {
1051
+ query: {"orgProcessId": {"value":"62c2d1cdfb5455c195d1baa1","oper":"=","type":"string"},"s":[{"historyBegin":{"order":"desc"}}],"i":1,"p":20},
1052
+ orgId: '55e4a3bd6be6b45210833fae',
1053
+ };
1054
+ const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
1055
+ const retSearch = await api.user.process.find(params, session);</code></pre>
1056
+
1057
+
1058
+
1059
+ </div>
1060
+
1061
+ <div class="member">
1062
+
1063
+
1064
+
1065
+ <h4 class="name" id="getOrgProcessSearchInfo">
1066
+ <a class="href-link" href="#getOrgProcessSearchInfo">#</a>
1067
+
1068
+
1069
+ <span class='tag'>async</span>
1070
+
1071
+
1072
+ <span class="code-name">
1073
+
1074
+ getOrgProcessSearchInfo<span class="signature">(params, session)</span><span class="type-signature"> &rarr; {Promise|string|object|object|object|string}</span>
1075
+
1076
+ </span>
1077
+ </h4>
1078
+
1079
+
1080
+
1081
+
1082
+ <div class="description">
1083
+ Get the search info of a organization process
1084
+ </div>
1085
+
1086
+
1087
+
1088
+
1089
+
1090
+
1091
+
1092
+
1093
+
1094
+
1095
+ <h5>Parameters:</h5>
1096
+
1097
+ <div class="table-container">
1098
+ <table class="params table">
1099
+ <thead>
1100
+ <tr>
1101
+
1102
+ <th>Name</th>
1103
+
1104
+
1105
+ <th>Type</th>
1106
+
1107
+
1108
+
1109
+
1110
+
1111
+ <th class="last">Description</th>
1112
+ </tr>
1113
+ </thead>
1114
+
1115
+ <tbody>
1116
+
1117
+
1118
+
1119
+ <tr class="deep-level-0">
1120
+
1121
+ <td class="name"><code>params</code></td>
1122
+
1123
+
1124
+ <td class="type">
1125
+
1126
+
1127
+ <code class="param-type">object</code>
1128
+
1129
+
1130
+
1131
+ </td>
1132
+
1133
+
1134
+
1135
+
1136
+
1137
+ <td class="description last">Params to get search info</td>
1138
+ </tr>
1139
+
1140
+
1141
+
1142
+
1143
+ <tr class="deep-level-1">
1144
+
1145
+ <td class="name"><code>orgProcessId</code></td>
1146
+
1147
+
1148
+ <td class="type">
1149
+
1150
+
1151
+ <code class="param-type">string</code>
1152
+
1153
+
1154
+
1155
+ </td>
1156
+
1157
+
1158
+
1159
+
1160
+
1161
+ <td class="description last">The id of an organization process (_id database);</td>
1162
+ </tr>
1163
+
1164
+
1165
+
1166
+ <tr class="deep-level-1">
1167
+
1168
+ <td class="name"><code>orgId</code></td>
1169
+
1170
+
1171
+ <td class="type">
1172
+
1173
+
1174
+ <code class="param-type">string</code>
1175
+
1176
+
1177
+
1178
+ </td>
1179
+
1180
+
1181
+
1182
+
1183
+
1184
+ <td class="description last">Organization id (_id database);</td>
1185
+ </tr>
1186
+
1187
+
1188
+
1189
+
1190
+
1191
+
1192
+
1193
+ <tr class="deep-level-0">
1194
+
1195
+ <td class="name"><code>session</code></td>
1196
+
1197
+
1198
+ <td class="type">
1199
+
1200
+
1201
+ <code class="param-type">string</code>
1202
+
1203
+
1204
+
1205
+ </td>
1206
+
1207
+
1208
+
1209
+
1210
+
1211
+ <td class="description last">Session, token JWT</td>
1212
+ </tr>
1213
+
1214
+
1215
+
1216
+ </tbody>
1217
+ </table>
1218
+ </div>
1219
+
1220
+
1221
+
1222
+
1223
+
1224
+ <dl class="details">
1225
+
1226
+
1227
+
1228
+
1229
+
1230
+
1231
+
1232
+
1233
+
1234
+
1235
+
1236
+
1237
+
1238
+
1239
+
1240
+
1241
+
1242
+
1243
+ <dt class="tag-author">Author:</dt>
1244
+ <dd class="tag-author">
1245
+ <ul>
1246
+ <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
1247
+ </ul>
1248
+ </dd>
1249
+
1250
+
1251
+
1252
+
1253
+
1254
+
1255
+
1256
+
1257
+
1258
+
1259
+
1260
+
1261
+
1262
+
1263
+ <p class="tag-source">
1264
+ <a href="user_process.js.html" class="button">View Source</a>
1265
+ <span>
1266
+ <a href="user_process.js.html">user/process.js</a>, <a href="user_process.js.html#line173">line 173</a>
1267
+ </span>
1268
+ </p>
1269
+
1270
+ </dl>
1271
+
1272
+
1273
+
1274
+
1275
+
1276
+
1277
+
1278
+
1279
+
1280
+
1281
+
1282
+
1283
+
1284
+
1285
+
1286
+
1287
+
1288
+
1289
+ <div class='columns method-parameter'>
1290
+ <div class="column is-2"><label>Returns:</label></div>
1291
+ <div class="column is-10">
1292
+
1293
+
1294
+
1295
+ <div class="columns">
1296
+
1297
+ <div class='param-desc column is-7'>the search info result</div>
1298
+
1299
+
1300
+ <div class='column is-5 has-text-left'>
1301
+ <label>Type: </label>
1302
+
1303
+ <code class="param-type">Promise</code>
1304
+
1305
+
1306
+ </div>
1307
+
1308
+ </div>
1309
+
1310
+
1311
+
1312
+
1313
+ <div class="columns">
1314
+
1315
+ <div class='param-desc column is-7'>name the name of the organization process</div>
1316
+
1317
+
1318
+ <div class='column is-5 has-text-left'>
1319
+ <label>Type: </label>
1320
+
1321
+ <code class="param-type">string</code>
1322
+
1323
+
1324
+ </div>
1325
+
1326
+ </div>
1327
+
1328
+
1329
+
1330
+
1331
+ <div class="columns">
1332
+
1333
+ <div class='param-desc column is-7'>processIndexFields the list of fields to index</div>
1334
+
1335
+
1336
+ <div class='column is-5 has-text-left'>
1337
+ <label>Type: </label>
1338
+
1339
+ <code class="param-type">object</code>
1340
+
1341
+
1342
+ </div>
1343
+
1344
+ </div>
1345
+
1346
+
1347
+
1348
+
1349
+ <div class="columns">
1350
+
1351
+ <div class='param-desc column is-7'>processParticipantsGroup the permissions in this organization process</div>
1352
+
1353
+
1354
+ <div class='column is-5 has-text-left'>
1355
+ <label>Type: </label>
1356
+
1357
+ <code class="param-type">object</code>
1358
+
1359
+
1360
+ </div>
1361
+
1362
+ </div>
1363
+
1364
+
1365
+
1366
+
1367
+ <div class="columns">
1368
+
1369
+ <div class='param-desc column is-7'>stepsProperties the organization process steps properties</div>
1370
+
1371
+
1372
+ <div class='column is-5 has-text-left'>
1373
+ <label>Type: </label>
1374
+
1375
+ <code class="param-type">object</code>
1376
+
1377
+
1378
+ </div>
1379
+
1380
+ </div>
1381
+
1382
+
1383
+
1384
+
1385
+ <div class="columns">
1386
+
1387
+ <div class='param-desc column is-7'>_id the same organization id
1388
+ @</div>
1389
+
1390
+
1391
+ <div class='column is-5 has-text-left'>
1392
+ <label>Type: </label>
1393
+
1394
+ <code class="param-type">string</code>
1395
+
1396
+
1397
+ </div>
1398
+
1399
+ </div>
1400
+
1401
+
1402
+ </div>
1403
+ </div>
1404
+
1405
+
1406
+
1407
+
1408
+ <h5>Example</h5>
1409
+
1410
+
1411
+ <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
1412
+ const api = new API();
1413
+ const params = {
1414
+ orgProcessId: '5dadd01dc4af3941d42f8c67',
1415
+ orgId: '5edd11c46b6ce9729c2c297c',
1416
+ }
1417
+ const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
1418
+ const retSearchInfo = await api.user.process.getOrgProcessSearchInfo(params, session);</code></pre>
1419
+
1420
+
1421
+
1422
+ </div>
1423
+
1424
+ <div class="member">
1425
+
1426
+
1427
+
1428
+ <h4 class="name" id="getProcessProperties">
1429
+ <a class="href-link" href="#getProcessProperties">#</a>
1430
+
1431
+
1432
+ <span class='tag'>async</span>
1433
+
1434
+
1435
+ <span class="code-name">
1436
+
1437
+ getProcessProperties<span class="signature">(params, session)</span><span class="type-signature"> &rarr; {Promise}</span>
1438
+
1439
+ </span>
1440
+ </h4>
1441
+
1442
+
1443
+
1444
+
1445
+ <div class="description">
1446
+ Get process properties of process
1447
+ </div>
1448
+
1449
+
1450
+
1451
+
1452
+
1453
+
1454
+
1455
+
1456
+
1457
+
1458
+ <h5>Parameters:</h5>
1459
+
1460
+ <div class="table-container">
1461
+ <table class="params table">
1462
+ <thead>
1463
+ <tr>
1464
+
1465
+ <th>Name</th>
1466
+
1467
+
1468
+ <th>Type</th>
1469
+
1470
+
1471
+
1472
+
1473
+
1474
+ <th class="last">Description</th>
1475
+ </tr>
1476
+ </thead>
1477
+
1478
+ <tbody>
1479
+
1480
+
1481
+
1482
+ <tr class="deep-level-0">
1483
+
1484
+ <td class="name"><code>params</code></td>
1485
+
1486
+
1487
+ <td class="type">
1488
+
1489
+
1490
+ <code class="param-type">object</code>
1491
+
1492
+
1493
+
1494
+ </td>
1495
+
1496
+
1497
+
1498
+
1499
+
1500
+ <td class="description last">Params to get process properties</td>
1501
+ </tr>
1502
+
1503
+
1504
+
1505
+
1506
+ <tr class="deep-level-1">
1507
+
1508
+ <td class="name"><code>processId</code></td>
1509
+
1510
+
1511
+ <td class="type">
1512
+
1513
+
1514
+ <code class="param-type">string</code>
314
1515
 
315
1516
 
316
1517
 
@@ -320,7 +1521,7 @@
320
1521
 
321
1522
 
322
1523
 
323
- <td class="description last">Search process query</td>
1524
+ <td class="description last">Process id (_id database);</td>
324
1525
  </tr>
325
1526
 
326
1527
 
@@ -333,7 +1534,7 @@
333
1534
  <td class="type">
334
1535
 
335
1536
 
336
- <code class="param-type">object</code>
1537
+ <code class="param-type">string</code>
337
1538
 
338
1539
 
339
1540
 
@@ -343,7 +1544,7 @@
343
1544
 
344
1545
 
345
1546
 
346
- <td class="description last">Organization id (_id database)</td>
1547
+ <td class="description last">Organization id (_id database);</td>
347
1548
  </tr>
348
1549
 
349
1550
 
@@ -425,7 +1626,7 @@
425
1626
  <p class="tag-source">
426
1627
  <a href="user_process.js.html" class="button">View Source</a>
427
1628
  <span>
428
- <a href="user_process.js.html">user/process.js</a>, <a href="user_process.js.html#line214">line 214</a>
1629
+ <a href="user_process.js.html">user/process.js</a>, <a href="user_process.js.html#line129">line 129</a>
429
1630
  </span>
430
1631
  </p>
431
1632
 
@@ -456,85 +1657,11 @@
456
1657
 
457
1658
  <div class="columns">
458
1659
 
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.&lt;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
1660
 
534
1661
  <div class='column is-5 has-text-left'>
535
1662
  <label>Type: </label>
536
1663
 
537
- <code class="param-type">number</code>
1664
+ <code class="param-type">Promise</code>
538
1665
 
539
1666
 
540
1667
  </div>
@@ -554,11 +1681,11 @@
554
1681
  <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
555
1682
  const api = new API();
556
1683
  const params = {
557
- query: {"orgProcessId": {"value":"62c2d1cdfb5455c195d1baa1","oper":"=","type":"string"},"s":[{"historyBegin":{"order":"desc"}}],"i":1,"p":20},
558
- orgId: '55e4a3bd6be6b45210833fae',
559
- };
1684
+ processId: '5dadd01dc4af3941d42f8c5c',
1685
+ orgId: '5edd11c46b6ce9729c2c297c',
1686
+ }
560
1687
  const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
561
- const retSearch = await api.user.process.find(params, session);</code></pre>
1688
+ await api.user.process.getProcessProperties(params, session);</code></pre>
562
1689
 
563
1690
 
564
1691
 
@@ -568,8 +1695,8 @@ const retSearch = await api.user.process.find(params, session);</code></pre>
568
1695
 
569
1696
 
570
1697
 
571
- <h4 class="name" id="getOrgProcessSearchInfo">
572
- <a class="href-link" href="#getOrgProcessSearchInfo">#</a>
1698
+ <h4 class="name" id="processDocs">
1699
+ <a class="href-link" href="#processDocs">#</a>
573
1700
 
574
1701
 
575
1702
  <span class='tag'>async</span>
@@ -577,7 +1704,7 @@ const retSearch = await api.user.process.find(params, session);</code></pre>
577
1704
 
578
1705
  <span class="code-name">
579
1706
 
580
- getOrgProcessSearchInfo<span class="signature">(params, session)</span><span class="type-signature"> &rarr; {Promise|string|object|object|object|string}</span>
1707
+ processDocs<span class="signature">(params, session)</span><span class="type-signature"> &rarr; {promise|array.&lt;object>}</span>
581
1708
 
582
1709
  </span>
583
1710
  </h4>
@@ -586,7 +1713,7 @@ const retSearch = await api.user.process.find(params, session);</code></pre>
586
1713
 
587
1714
 
588
1715
  <div class="description">
589
- Get the search info of a organization process
1716
+ Method to get Process Docs
590
1717
  </div>
591
1718
 
592
1719
 
@@ -640,7 +1767,7 @@ const retSearch = await api.user.process.find(params, session);</code></pre>
640
1767
 
641
1768
 
642
1769
 
643
- <td class="description last">Params to get search info</td>
1770
+ <td class="description last">Params to get process docs</td>
644
1771
  </tr>
645
1772
 
646
1773
 
@@ -664,7 +1791,30 @@ const retSearch = await api.user.process.find(params, session);</code></pre>
664
1791
 
665
1792
 
666
1793
 
667
- <td class="description last">The id of an organization process (_id database);</td>
1794
+ <td class="description last">Organization Process Id</td>
1795
+ </tr>
1796
+
1797
+
1798
+
1799
+ <tr class="deep-level-1">
1800
+
1801
+ <td class="name"><code>processId</code></td>
1802
+
1803
+
1804
+ <td class="type">
1805
+
1806
+
1807
+ <code class="param-type">string</code>
1808
+
1809
+
1810
+
1811
+ </td>
1812
+
1813
+
1814
+
1815
+
1816
+
1817
+ <td class="description last">Process Id</td>
668
1818
  </tr>
669
1819
 
670
1820
 
@@ -687,7 +1837,7 @@ const retSearch = await api.user.process.find(params, session);</code></pre>
687
1837
 
688
1838
 
689
1839
 
690
- <td class="description last">Organization id (_id database);</td>
1840
+ <td class="description last">Organization id (_id database)</td>
691
1841
  </tr>
692
1842
 
693
1843
 
@@ -769,7 +1919,7 @@ const retSearch = await api.user.process.find(params, session);</code></pre>
769
1919
  <p class="tag-source">
770
1920
  <a href="user_process.js.html" class="button">View Source</a>
771
1921
  <span>
772
- <a href="user_process.js.html">user/process.js</a>, <a href="user_process.js.html#line173">line 173</a>
1922
+ <a href="user_process.js.html">user/process.js</a>, <a href="user_process.js.html#line372">line 372</a>
773
1923
  </span>
774
1924
  </p>
775
1925
 
@@ -800,85 +1950,13 @@ const retSearch = await api.user.process.find(params, session);</code></pre>
800
1950
 
801
1951
  <div class="columns">
802
1952
 
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>
1953
+ <div class='param-desc column is-7'>returned data from the get process docs</div>
876
1954
 
877
1955
 
878
1956
  <div class='column is-5 has-text-left'>
879
1957
  <label>Type: </label>
880
1958
 
881
- <code class="param-type">object</code>
1959
+ <code class="param-type">promise</code>
882
1960
 
883
1961
 
884
1962
  </div>
@@ -890,14 +1968,13 @@ const retSearch = await api.user.process.find(params, session);</code></pre>
890
1968
 
891
1969
  <div class="columns">
892
1970
 
893
- <div class='param-desc column is-7'>_id the same organization id
894
- @</div>
1971
+ <div class='param-desc column is-7'>Docs returned from process</div>
895
1972
 
896
1973
 
897
1974
  <div class='column is-5 has-text-left'>
898
1975
  <label>Type: </label>
899
1976
 
900
- <code class="param-type">string</code>
1977
+ <code class="param-type">array.&lt;object></code>
901
1978
 
902
1979
 
903
1980
  </div>
@@ -917,11 +1994,12 @@ const retSearch = await api.user.process.find(params, session);</code></pre>
917
1994
  <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
918
1995
  const api = new API();
919
1996
  const params = {
920
- orgProcessId: '5dadd01dc4af3941d42f8c67',
921
- orgId: '5edd11c46b6ce9729c2c297c',
922
- }
1997
+ orgProcessId: '55e4a3bd6be6b45210833fae',
1998
+ processId: '55e4a3bd6be6b45210833fae',
1999
+ orgId: '55e4a3bd6be6b45210833fae',
2000
+ };
923
2001
  const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
924
- const retSearchInfo = await api.user.process.getOrgProcessSearchInfo(params, session);</code></pre>
2002
+ const retSearch = await api.user.process.processDocs(params, session);</code></pre>
925
2003
 
926
2004
 
927
2005
 
@@ -931,8 +2009,8 @@ const retSearchInfo = await api.user.process.getOrgProcessSearchInfo(params, ses
931
2009
 
932
2010
 
933
2011
 
934
- <h4 class="name" id="getProcessProperties">
935
- <a class="href-link" href="#getProcessProperties">#</a>
2012
+ <h4 class="name" id="remove">
2013
+ <a class="href-link" href="#remove">#</a>
936
2014
 
937
2015
 
938
2016
  <span class='tag'>async</span>
@@ -940,7 +2018,7 @@ const retSearchInfo = await api.user.process.getOrgProcessSearchInfo(params, ses
940
2018
 
941
2019
  <span class="code-name">
942
2020
 
943
- getProcessProperties<span class="signature">(params, session)</span><span class="type-signature"> &rarr; {Promise}</span>
2021
+ remove<span class="signature">(params, session)</span><span class="type-signature"></span>
944
2022
 
945
2023
  </span>
946
2024
  </h4>
@@ -949,7 +2027,7 @@ const retSearchInfo = await api.user.process.getOrgProcessSearchInfo(params, ses
949
2027
 
950
2028
 
951
2029
  <div class="description">
952
- Get process properties of process
2030
+ Method to remove process
953
2031
  </div>
954
2032
 
955
2033
 
@@ -1003,7 +2081,7 @@ const retSearchInfo = await api.user.process.getOrgProcessSearchInfo(params, ses
1003
2081
 
1004
2082
 
1005
2083
 
1006
- <td class="description last">Params to get process properties</td>
2084
+ <td class="description last">Params to remove process</td>
1007
2085
  </tr>
1008
2086
 
1009
2087
 
@@ -1011,13 +2089,13 @@ const retSearchInfo = await api.user.process.getOrgProcessSearchInfo(params, ses
1011
2089
 
1012
2090
  <tr class="deep-level-1">
1013
2091
 
1014
- <td class="name"><code>processId</code></td>
2092
+ <td class="name"><code>orgId</code></td>
1015
2093
 
1016
2094
 
1017
2095
  <td class="type">
1018
2096
 
1019
2097
 
1020
- <code class="param-type">string</code>
2098
+ <code class="param-type">object</code>
1021
2099
 
1022
2100
 
1023
2101
 
@@ -1027,20 +2105,20 @@ const retSearchInfo = await api.user.process.getOrgProcessSearchInfo(params, ses
1027
2105
 
1028
2106
 
1029
2107
 
1030
- <td class="description last">Process id (_id database);</td>
2108
+ <td class="description last">Organization id (_id database)</td>
1031
2109
  </tr>
1032
2110
 
1033
2111
 
1034
2112
 
1035
2113
  <tr class="deep-level-1">
1036
2114
 
1037
- <td class="name"><code>orgId</code></td>
2115
+ <td class="name"><code>processId</code></td>
1038
2116
 
1039
2117
 
1040
2118
  <td class="type">
1041
2119
 
1042
2120
 
1043
- <code class="param-type">string</code>
2121
+ <code class="param-type">object</code>
1044
2122
 
1045
2123
 
1046
2124
 
@@ -1050,7 +2128,7 @@ const retSearchInfo = await api.user.process.getOrgProcessSearchInfo(params, ses
1050
2128
 
1051
2129
 
1052
2130
 
1053
- <td class="description last">Organization id (_id database);</td>
2131
+ <td class="description last">Process id (_id database)</td>
1054
2132
  </tr>
1055
2133
 
1056
2134
 
@@ -1132,7 +2210,7 @@ const retSearchInfo = await api.user.process.getOrgProcessSearchInfo(params, ses
1132
2210
  <p class="tag-source">
1133
2211
  <a href="user_process.js.html" class="button">View Source</a>
1134
2212
  <span>
1135
- <a href="user_process.js.html">user/process.js</a>, <a href="user_process.js.html#line129">line 129</a>
2213
+ <a href="user_process.js.html">user/process.js</a>, <a href="user_process.js.html#line253">line 253</a>
1136
2214
  </span>
1137
2215
  </p>
1138
2216
 
@@ -1155,29 +2233,6 @@ const retSearchInfo = await api.user.process.getOrgProcessSearchInfo(params, ses
1155
2233
 
1156
2234
 
1157
2235
 
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
2236
 
1182
2237
 
1183
2238
 
@@ -1187,11 +2242,11 @@ const retSearchInfo = await api.user.process.getOrgProcessSearchInfo(params, ses
1187
2242
  <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
1188
2243
  const api = new API();
1189
2244
  const params = {
1190
- processId: '5dadd01dc4af3941d42f8c5c',
1191
- orgId: '5edd11c46b6ce9729c2c297c',
1192
- }
2245
+ orgId: '55e4a3bd6be6b45210833fae',
2246
+ processId: '55e4a3bd6be6b45210833fae'
2247
+ };
1193
2248
  const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
1194
- await api.user.process.getProcessProperties(params, session);</code></pre>
2249
+ const retSearch = await api.user.process.remove(params, session);</code></pre>
1195
2250
 
1196
2251
 
1197
2252