@docbrasil/api-systemmanager 1.1.26 → 1.1.27

package/doc/api.md

@@ -1398,6 +1398,11 @@ await api.user.application.list(params, session);
 Class user access to charts
 
 **Kind**: global class  
+
+* [Chart](#Chart)
+    * [.getData(params, session)](#Chart+getData) ⇒ <code>promise</code>
+    * [.getQuestion(params, session)](#Chart+getQuestion) ⇒ <code>promise</code>
+
 <a name="Chart+getData"></a>
 
 ### chart.getData(params, session) ⇒ <code>promise</code>
@@ -1424,6 +1429,36 @@ const params = {
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
 await api.user.dashboard.chart.getData(params, session);
 ```
+<a name="Chart+getQuestion"></a>
+
+### chart.getQuestion(params, session) ⇒ <code>promise</code>
+Get the question data from a chart data
+
+**Kind**: instance method of [<code>Chart</code>](#Chart)  
+**Returns**: <code>promise</code> - data the question data  
+**Access**: public  
+**Author**: Myndware <augusto.pissarra@myndware.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params | <code>object</code> | Params to get helps from topic |
+| params.orgId | <code>object</code> | The organization id of the question |
+| params.processId | <code>object</code> | The process id of the question |
+| params.path | <code>object</code> | The path of the question so we can retrieve it |
+| session | <code>string</code> | Session, token JWT |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = {
+ orgId: '637e7523f555fabdfb1ed7b6',
+ processId: '123e7523f555fabdfb1ed7c6',
+ path: 'Checklist.Group Name.Field Name'
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.dashboard.chart.getQuestion(params, session);
+```
 <a name="Dashboard"></a>
 
 ## Dashboard

package/docs/Chart.html

@@ -487,6 +487,302 @@ await api.user.dashboard.chart.getData(params, session);</code></pre>
     
 
 
+</div>
+            
+                <div class="member">
+
+
+    
+    <h4 class="name" id="getQuestion">
+        <a class="href-link" href="#getQuestion">#</a>
+        
+            
+                <span class='tag'>async</span>
+            
+        
+        <span class="code-name">
+            
+                getQuestion<span class="signature">(params, session)</span><span class="type-signature"> &rarr; {promise}</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    
+    <div class="description">
+        Get the question data from a chart data
+    </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 get helps from topic</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">The organization id of the question</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">The process id of the question</td>
+</tr>
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>path</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">object</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">The path of the question so we can retrieve it</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_dashboard.js.html" class="button">View Source</a>
+            <span>
+                <a href="user_dashboard.js.html">user/dashboard.js</a>, <a href="user_dashboard.js.html#line107">line 107</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'>data the question data</div>
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>Type: </label>
+        
+<code class="param-type">promise</code>
+
+
+    </div>
+    
+</div>
+
+                
+        </div>
+    </div>
+
+
+
+
+    <h5>Example</h5>
+    
+    
+        <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = {
+ orgId: '637e7523f555fabdfb1ed7b6',
+ processId: '123e7523f555fabdfb1ed7c6',
+ path: 'Checklist.Group Name.Field Name'
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.dashboard.chart.getQuestion(params, session);</code></pre>
+    
+
+
 </div>
             
             </div>

package/docs/Dashboard.html

@@ -167,7 +167,7 @@
         <p class="tag-source">
             <a href="user_dashboard.js.html" class="button">View Source</a>
             <span>
-                <a href="user_dashboard.js.html">user/dashboard.js</a>, <a href="user_dashboard.js.html#line90">line 90</a>
+                <a href="user_dashboard.js.html">user/dashboard.js</a>, <a href="user_dashboard.js.html#line130">line 130</a>
             </span>
         </p>
     
@@ -286,7 +286,7 @@
         <p class="tag-source">
             <a href="user_dashboard.js.html" class="button">View Source</a>
             <span>
-                <a href="user_dashboard.js.html">user/dashboard.js</a>, <a href="user_dashboard.js.html#line144">line 144</a>
+                <a href="user_dashboard.js.html">user/dashboard.js</a>, <a href="user_dashboard.js.html#line184">line 184</a>
             </span>
         </p>