@docbrasil/api-systemmanager 1.1.89 → 1.1.91

package/docs/Process.html

@@ -2801,8 +2801,8 @@ await api.user.process.getProcessProperties(params, session);</code></pre>
 
 
     
-    <h4 class="name" id="getStepHistory">
-        <a class="href-link" href="#getStepHistory">#</a>
+    <h4 class="name" id="processDocs">
+        <a class="href-link" href="#processDocs">#</a>
         
             
                 <span class='tag'>async</span>
@@ -2810,7 +2810,7 @@ await api.user.process.getProcessProperties(params, session);</code></pre>
         
         <span class="code-name">
             
-                getStepHistory<span class="signature">(params, session)</span><span class="type-signature"> &rarr; {Promise.&lt;Array>}</span>
+                processDocs<span class="signature">(params, session)</span><span class="type-signature"> &rarr; {promise|array.&lt;object>}</span>
             
         </span>
     </h4>
@@ -2819,7 +2819,7 @@ await api.user.process.getProcessProperties(params, session);</code></pre>
     
     
     <div class="description">
-        Get step history of a process flow
+        Method to get Process Docs
     </div>
     
 
@@ -2873,7 +2873,7 @@ await api.user.process.getProcessProperties(params, session);</code></pre>
 
   
 
-  <td class="description last">Params to get step history</td>
+  <td class="description last">Params to get process docs</td>
 </tr>
 
   
@@ -2881,7 +2881,7 @@ await api.user.process.getProcessProperties(params, session);</code></pre>
     
 <tr class="deep-level-1">
   
-      <td class="name"><code>orgId</code></td>
+      <td class="name"><code>orgProcessId</code></td>
   
 
   <td class="type">
@@ -2897,7 +2897,7 @@ await api.user.process.getProcessProperties(params, session);</code></pre>
 
   
 
-  <td class="description last">Organization id (_id database);</td>
+  <td class="description last">Organization Process Id</td>
 </tr>
 
   
@@ -2920,14 +2920,14 @@ await api.user.process.getProcessProperties(params, session);</code></pre>
 
   
 
-  <td class="description last">Process id (_id database);</td>
+  <td class="description last">Process Id</td>
 </tr>
 
   
     
 <tr class="deep-level-1">
   
-      <td class="name"><code>flowId</code></td>
+      <td class="name"><code>orgId</code></td>
   
 
   <td class="type">
@@ -2943,7 +2943,7 @@ await api.user.process.getProcessProperties(params, session);</code></pre>
 
   
 
-  <td class="description last">Flow id;</td>
+  <td class="description last">Organization id (_id database)</td>
 </tr>
 
   
@@ -3025,7 +3025,7 @@ await api.user.process.getProcessProperties(params, session);</code></pre>
         <p class="tag-source">
             <a href="user_process.js.html" class="button">View Source</a>
             <span>
-                <a href="user_process.js.html">user/process.js</a>, <a href="user_process.js.html#line580">line 580</a>
+                <a href="user_process.js.html">user/process.js</a>, <a href="user_process.js.html#line372">line 372</a>
             </span>
         </p>
     
@@ -3056,13 +3056,31 @@ await api.user.process.getProcessProperties(params, session);</code></pre>
 
 <div class="columns">
     
-    <div class='param-desc column is-7'>Array of step history entries</div>
+    <div class='param-desc column is-7'>returned data from the get process docs</div>
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>Type: </label>
+        
+<code class="param-type">promise</code>
+
+
+    </div>
+    
+</div>
+
+                
+                    
+
+<div class="columns">
+    
+    <div class='param-desc column is-7'>Docs returned from process</div>
     
     
     <div class='column is-5 has-text-left'>
         <label>Type: </label>
         
-<code class="param-type">Promise.&lt;Array></code>
+<code class="param-type">array.&lt;object></code>
 
 
     </div>
@@ -3082,12 +3100,12 @@ await api.user.process.getProcessProperties(params, session);</code></pre>
         <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
 const api = new API();
 const params = {
-  orgId: '5edd11c46b6ce9729c2c297c',
-  processId: '5dadd01dc4af3941d42f8c5c',
-  flowId: 'Task_18v1xx7'
-}
+ orgProcessId: '55e4a3bd6be6b45210833fae',
+ processId: '55e4a3bd6be6b45210833fae',
+ orgId: '55e4a3bd6be6b45210833fae',
+};
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
-const stepHistory = await api.user.process.getStepHistory(params, session);</code></pre>
+const retSearch = await api.user.process.processDocs(params, session);</code></pre>
     
 
 
@@ -3097,8 +3115,8 @@ const stepHistory = await api.user.process.getStepHistory(params, session);</cod
 
 
     
-    <h4 class="name" id="processDocs">
-        <a class="href-link" href="#processDocs">#</a>
+    <h4 class="name" id="reexecute">
+        <a class="href-link" href="#reexecute">#</a>
         
             
                 <span class='tag'>async</span>
@@ -3106,7 +3124,7 @@ const stepHistory = await api.user.process.getStepHistory(params, session);</cod
         
         <span class="code-name">
             
-                processDocs<span class="signature">(params, session)</span><span class="type-signature"> &rarr; {promise|array.&lt;object>}</span>
+                reexecute<span class="signature">(params, session)</span><span class="type-signature"> &rarr; {Promise.&lt;object>}</span>
             
         </span>
     </h4>
@@ -3115,7 +3133,8 @@ const stepHistory = await api.user.process.getStepHistory(params, session);</cod
     
     
     <div class="description">
-        Method to get Process Docs
+        Re-execute a specific flow step in a running process. Unlike restart, this does not
+reset the process completion state. Task creation is deferred to the BPMN engine via RabbitMQ.
     </div>
     
 
@@ -3169,7 +3188,7 @@ const stepHistory = await api.user.process.getStepHistory(params, session);</cod
 
   
 
-  <td class="description last">Params to get process docs</td>
+  <td class="description last">Params to re-execute the process step</td>
 </tr>
 
   
@@ -3177,7 +3196,7 @@ const stepHistory = await api.user.process.getStepHistory(params, session);</cod
     
 <tr class="deep-level-1">
   
-      <td class="name"><code>orgProcessId</code></td>
+      <td class="name"><code>processId</code></td>
   
 
   <td class="type">
@@ -3193,14 +3212,14 @@ const stepHistory = await api.user.process.getStepHistory(params, session);</cod
 
   
 
-  <td class="description last">Organization Process Id</td>
+  <td class="description last">Process id (_id database);</td>
 </tr>
 
   
     
 <tr class="deep-level-1">
   
-      <td class="name"><code>processId</code></td>
+      <td class="name"><code>orgId</code></td>
   
 
   <td class="type">
@@ -3216,14 +3235,14 @@ const stepHistory = await api.user.process.getStepHistory(params, session);</cod
 
   
 
-  <td class="description last">Process Id</td>
+  <td class="description last">Organization id (_id database);</td>
 </tr>
 
   
     
 <tr class="deep-level-1">
   
-      <td class="name"><code>orgId</code></td>
+      <td class="name"><code>flowName</code></td>
   
 
   <td class="type">
@@ -3239,7 +3258,7 @@ const stepHistory = await api.user.process.getStepHistory(params, session);</cod
 
   
 
-  <td class="description last">Organization id (_id database)</td>
+  <td class="description last">The flow name of the step to re-execute;</td>
 </tr>
 
   
@@ -3321,7 +3340,7 @@ const stepHistory = await api.user.process.getStepHistory(params, session);</cod
         <p class="tag-source">
             <a href="user_process.js.html" class="button">View Source</a>
             <span>
-                <a href="user_process.js.html">user/process.js</a>, <a href="user_process.js.html#line372">line 372</a>
+                <a href="user_process.js.html">user/process.js</a>, <a href="user_process.js.html#line646">line 646</a>
             </span>
         </p>
     
@@ -3352,31 +3371,13 @@ const stepHistory = await api.user.process.getStepHistory(params, session);</cod
 
 <div class="columns">
     
-    <div class='param-desc column is-7'>returned data from the get process docs</div>
-    
-    
-    <div class='column is-5 has-text-left'>
-        <label>Type: </label>
-        
-<code class="param-type">promise</code>
-
-
-    </div>
-    
-</div>
-
-                
-                    
-
-<div class="columns">
-    
-    <div class='param-desc column is-7'>Docs returned from process</div>
+    <div class='param-desc column is-7'>{ response: 'OK' } on success</div>
     
     
     <div class='column is-5 has-text-left'>
         <label>Type: </label>
         
-<code class="param-type">array.&lt;object></code>
+<code class="param-type">Promise.&lt;object></code>
 
 
     </div>
@@ -3396,12 +3397,12 @@ const stepHistory = await api.user.process.getStepHistory(params, session);</cod
         <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
 const api = new API();
 const params = {
- orgProcessId: '55e4a3bd6be6b45210833fae',
- processId: '55e4a3bd6be6b45210833fae',
- orgId: '55e4a3bd6be6b45210833fae',
+  processId: '5dadd01dc4af3941d42f8c5c',
+  orgId: '5edd11c46b6ce9729c2c297c',
+  flowName: 'Task_1'
 };
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
-const retSearch = await api.user.process.processDocs(params, session);</code></pre>
+await api.user.process.reexecute(params, session);</code></pre>
     
 
 
@@ -3411,8 +3412,8 @@ const retSearch = await api.user.process.processDocs(params, session);</code></p
 
 
     
-    <h4 class="name" id="remove">
-        <a class="href-link" href="#remove">#</a>
+    <h4 class="name" id="reexecuteTask">
+        <a class="href-link" href="#reexecuteTask">#</a>
         
             
                 <span class='tag'>async</span>
@@ -3420,7 +3421,7 @@ const retSearch = await api.user.process.processDocs(params, session);</code></p
         
         <span class="code-name">
             
-                remove<span class="signature">(params, session)</span><span class="type-signature"></span>
+                reexecuteTask<span class="signature">(params, session)</span><span class="type-signature"> &rarr; {Promise.&lt;object>}</span>
             
         </span>
     </h4>
@@ -3429,7 +3430,9 @@ const retSearch = await api.user.process.processDocs(params, session);</code></p
     
     
     <div class="description">
-        Method to remove process
+        Re-execute a specific user task step in a running process, creating a new task
+synchronously with optional userId reassignment. For non-group tasks, the task is reassigned
+to the current logged-in user. For group tasks, the original assignment is preserved.
     </div>
     
 
@@ -3483,12 +3486,35 @@ const retSearch = await api.user.process.processDocs(params, session);</code></p
 
   
 
-  <td class="description last">Params to remove process</td>
+  <td class="description last">Params to re-execute the task</td>
 </tr>
 
   
   
     
+<tr class="deep-level-1">
+  
+      <td class="name"><code>processId</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">Process id (_id database);</td>
+</tr>
+
+  
+    
 <tr class="deep-level-1">
   
       <td class="name"><code>orgId</code></td>
@@ -3497,7 +3523,7 @@ const retSearch = await api.user.process.processDocs(params, session);</code></p
   <td class="type">
   
       
-<code class="param-type">object</code>
+<code class="param-type">string</code>
 
 
   
@@ -3507,20 +3533,20 @@ const retSearch = await api.user.process.processDocs(params, session);</code></p
 
   
 
-  <td class="description last">Organization id (_id database)</td>
+  <td class="description last">Organization id (_id database);</td>
 </tr>
 
   
     
 <tr class="deep-level-1">
   
-      <td class="name"><code>processId</code></td>
+      <td class="name"><code>flowName</code></td>
   
 
   <td class="type">
   
       
-<code class="param-type">object</code>
+<code class="param-type">string</code>
 
 
   
@@ -3530,7 +3556,7 @@ const retSearch = await api.user.process.processDocs(params, session);</code></p
 
   
 
-  <td class="description last">Process id (_id database)</td>
+  <td class="description last">The flow name of the user task step to re-execute;</td>
 </tr>
 
   
@@ -3612,7 +3638,7 @@ const retSearch = await api.user.process.processDocs(params, session);</code></p
         <p class="tag-source">
             <a href="user_process.js.html" class="button">View Source</a>
             <span>
-                <a href="user_process.js.html">user/process.js</a>, <a href="user_process.js.html#line253">line 253</a>
+                <a href="user_process.js.html">user/process.js</a>, <a href="user_process.js.html#line690">line 690</a>
             </span>
         </p>
     
@@ -3635,6 +3661,31 @@ const retSearch = await api.user.process.processDocs(params, session);</code></p
 
 
 
+    <div class='columns method-parameter'>
+        <div class="column is-2"><label>Returns:</label></div>
+        <div class="column is-10">
+            
+                    
+
+<div class="columns">
+    
+    <div class='param-desc column is-7'>{ response: 'OK', taskId } on success</div>
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>Type: </label>
+        
+<code class="param-type">Promise.&lt;object></code>
+
+
+    </div>
+    
+</div>
+
+                
+        </div>
+    </div>
+
 
 
 
@@ -3644,11 +3695,557 @@ const retSearch = await api.user.process.processDocs(params, session);</code></p
         <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
 const api = new API();
 const params = {
- orgId: '55e4a3bd6be6b45210833fae',
- processId: '55e4a3bd6be6b45210833fae'
+  processId: '5dadd01dc4af3941d42f8c5c',
+  orgId: '5edd11c46b6ce9729c2c297c',
+  flowName: 'Task_1'
 };
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
-const retSearch = await api.user.process.remove(params, session);</code></pre>
+const result = await api.user.process.reexecuteTask(params, session);
+console.log(result.taskId);</code></pre>
+    
+
+
+</div>
+            
+                <div class="member">
+
+
+    
+    <h4 class="name" id="remove">
+        <a class="href-link" href="#remove">#</a>
+        
+            
+                <span class='tag'>async</span>
+            
+        
+        <span class="code-name">
+            
+                remove<span class="signature">(params, session)</span><span class="type-signature"></span>
+            
+        </span>
+    </h4>
+    
+
+    
+    
+    <div class="description">
+        Method to remove process
+    </div>
+    
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+<div class="table-container">
+    <table class="params table">
+        <thead>
+        <tr>
+            
+            <th>Name</th>
+            
+
+            <th>Type</th>
+
+            
+
+            
+
+            <th class="last">Description</th>
+        </tr>
+        </thead>
+
+        <tbody>
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>params</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">object</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">Params to remove process</td>
+</tr>
+
+  
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>orgId</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">object</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">Organization id (_id database)</td>
+</tr>
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>processId</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">object</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">Process id (_id database)</td>
+</tr>
+
+  
+
+
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>session</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">Session, token JWT</td>
+</tr>
+
+
+        
+        </tbody>
+    </table>
+</div>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-author">Author:</dt>
+    <dd class="tag-author">
+        <ul>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
+        </ul>
+    </dd>
+    
+
+    
+
+    
+
+    
+    
+
+    
+
+    
+
+    
+        <p class="tag-source">
+            <a href="user_process.js.html" class="button">View Source</a>
+            <span>
+                <a href="user_process.js.html">user/process.js</a>, <a href="user_process.js.html#line253">line 253</a>
+            </span>
+        </p>
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    <h5>Example</h5>
+    
+    
+        <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = {
+ orgId: '55e4a3bd6be6b45210833fae',
+ processId: '55e4a3bd6be6b45210833fae'
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+const retSearch = await api.user.process.remove(params, session);</code></pre>
+    
+
+
+</div>
+            
+                <div class="member">
+
+
+    
+    <h4 class="name" id="restart">
+        <a class="href-link" href="#restart">#</a>
+        
+            
+                <span class='tag'>async</span>
+            
+        
+        <span class="code-name">
+            
+                restart<span class="signature">(params, session)</span><span class="type-signature"> &rarr; {Promise.&lt;object>}</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    
+    <div class="description">
+        Restart a finished process from a specific flow step. Resets the process completion state
+and triggers re-execution from the specified flow name.
+    </div>
+    
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+<div class="table-container">
+    <table class="params table">
+        <thead>
+        <tr>
+            
+            <th>Name</th>
+            
+
+            <th>Type</th>
+
+            
+
+            
+
+            <th class="last">Description</th>
+        </tr>
+        </thead>
+
+        <tbody>
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>params</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">object</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">Params to restart the process</td>
+</tr>
+
+  
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>processId</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">Process id (_id database);</td>
+</tr>
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>orgId</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">Organization id (_id database);</td>
+</tr>
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>flowName</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">The flow name of the step to restart from;</td>
+</tr>
+
+  
+
+
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>session</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">Session, token JWT</td>
+</tr>
+
+
+        
+        </tbody>
+    </table>
+</div>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-author">Author:</dt>
+    <dd class="tag-author">
+        <ul>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
+        </ul>
+    </dd>
+    
+
+    
+
+    
+
+    
+    
+
+    
+
+    
+
+    
+        <p class="tag-source">
+            <a href="user_process.js.html" class="button">View Source</a>
+            <span>
+                <a href="user_process.js.html">user/process.js</a>, <a href="user_process.js.html#line604">line 604</a>
+            </span>
+        </p>
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    <div class='columns method-parameter'>
+        <div class="column is-2"><label>Returns:</label></div>
+        <div class="column is-10">
+            
+                    
+
+<div class="columns">
+    
+    <div class='param-desc column is-7'>{ response: 'OK' } on success</div>
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>Type: </label>
+        
+<code class="param-type">Promise.&lt;object></code>
+
+
+    </div>
+    
+</div>
+
+                
+        </div>
+    </div>
+
+
+
+
+    <h5>Example</h5>
+    
+    
+        <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = {
+  processId: '5dadd01dc4af3941d42f8c5c',
+  orgId: '5edd11c46b6ce9729c2c297c',
+  flowName: 'Task_1'
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.process.restart(params, session);</code></pre>