@docbrasil/api-systemmanager 1.0.110 → 1.0.111

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/doc/api.md CHANGED
@@ -1907,6 +1907,9 @@ Class for process, permission user
1907
1907
  * [.getProcessProperties(params, session)](#Process+getProcessProperties) ⇒ <code>Promise</code>
1908
1908
  * [.getOrgProcessSearchInfo(params, session)](#Process+getOrgProcessSearchInfo) ⇒ <code>Promise</code> \| <code>string</code> \| <code>object</code> \| <code>object</code> \| <code>object</code> \| <code>string</code>
1909
1909
  * [.find(params, session)](#Process+find) ⇒ <code>promise</code> \| <code>number</code> \| <code>array.&lt;object&gt;</code> \| <code>number</code> \| <code>number</code>
1910
+ * [.remove(params, session)](#Process+remove)
1911
+ * [.exportStatusData(params, session)](#Process+exportStatusData)
1912
+ * [.exportProcessData(params, session)](#Process+exportProcessData)
1910
1913
 
1911
1914
  <a name="Process+start"></a>
1912
1915
 
@@ -2021,6 +2024,87 @@ const params = {
2021
2024
  const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
2022
2025
  const retSearch = await api.user.process.find(params, session);
2023
2026
  ```
2027
+ <a name="Process+remove"></a>
2028
+
2029
+ ### process.remove(params, session)
2030
+ Method to remove process
2031
+
2032
+ **Kind**: instance method of [<code>Process</code>](#Process)
2033
+ **Access**: public
2034
+ **Author**: CloudBrasil <abernardo.br@gmail.com>
2035
+
2036
+ | Param | Type | Description |
2037
+ | --- | --- | --- |
2038
+ | params | <code>object</code> | Params to remove process |
2039
+ | params.orgId | <code>object</code> | Organization id (_id database) |
2040
+ | params.processId | <code>object</code> | Process id (_id database) |
2041
+ | session | <code>string</code> | Session, token JWT |
2042
+
2043
+ **Example**
2044
+ ```js
2045
+ const API = require('@docbrasil/api-systemmanager');
2046
+ const api = new API();
2047
+ const params = {
2048
+ orgId: '55e4a3bd6be6b45210833fae',
2049
+ processId: '55e4a3bd6be6b45210833fae'
2050
+ };
2051
+ const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
2052
+ const retSearch = await api.user.process.remove(params, session);
2053
+ ```
2054
+ <a name="Process+exportStatusData"></a>
2055
+
2056
+ ### process.exportStatusData(params, session)
2057
+ Method to export status data
2058
+
2059
+ **Kind**: instance method of [<code>Process</code>](#Process)
2060
+ **Access**: public
2061
+ **Author**: CloudBrasil <abernardo.br@gmail.com>
2062
+
2063
+ | Param | Type | Description |
2064
+ | --- | --- | --- |
2065
+ | params | <code>object</code> | Params to export status data |
2066
+ | params.query | <code>object</code> | Search process query |
2067
+ | params.orgId | <code>object</code> | Organization id (_id database) |
2068
+ | session | <code>string</code> | Session, token JWT |
2069
+
2070
+ **Example**
2071
+ ```js
2072
+ const API = require('@docbrasil/api-systemmanager');
2073
+ const api = new API();
2074
+ const params = {
2075
+ query: {"orgProcessId": {"value":"62c2d1cdfb5455c195d1baa1","oper":"=","type":"string"},"s":[{"historyBegin":{"order":"desc"}}],"i":1,"p":20},
2076
+ orgId: '55e4a3bd6be6b45210833fae',
2077
+ };
2078
+ const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
2079
+ const retSearch = await api.user.process.exportStatusData(params, session);
2080
+ ```
2081
+ <a name="Process+exportProcessData"></a>
2082
+
2083
+ ### process.exportProcessData(params, session)
2084
+ Method to export process data
2085
+
2086
+ **Kind**: instance method of [<code>Process</code>](#Process)
2087
+ **Access**: public
2088
+ **Author**: CloudBrasil <abernardo.br@gmail.com>
2089
+
2090
+ | Param | Type | Description |
2091
+ | --- | --- | --- |
2092
+ | params | <code>object</code> | Params to export process data |
2093
+ | params.query | <code>object</code> | Search process query |
2094
+ | params.orgId | <code>object</code> | Organization id (_id database) |
2095
+ | session | <code>string</code> | Session, token JWT |
2096
+
2097
+ **Example**
2098
+ ```js
2099
+ const API = require('@docbrasil/api-systemmanager');
2100
+ const api = new API();
2101
+ const params = {
2102
+ query: {"orgProcessId": {"value":"62c2d1cdfb5455c195d1baa1","oper":"=","type":"string"},"s":[{"historyBegin":{"order":"desc"}}],"i":1,"p":20},
2103
+ orgId: '55e4a3bd6be6b45210833fae',
2104
+ };
2105
+ const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
2106
+ const retSearch = await api.user.process.exportProcessData(params, session);
2107
+ ```
2024
2108
  <a name="Register"></a>
2025
2109
 
2026
2110
  ## Register
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@docbrasil/api-systemmanager",
3
3
  "description": "Module API System Manager",
4
- "version": "1.0.110",
4
+ "version": "1.0.111",
5
5
  "scripts": {
6
6
  "htmldoc": "rm -rf docs && jsdoc api/** -d docs -t ./node_modules/better-docs",
7
7
  "doc": "rm -rf doc && mkdir doc && jsdoc2md api/**/* api/* > doc/api.md",