Denys Vuika ea2c0ce229
[PRODENG-211] integrate JS-API with monorepo (part 1) (#9081)
* integrate JS-API with monorepo

* [ci:force] fix token issue

[ci:force] migrate docs folder

[ci:force] clean personal tokens

* [ci:force] gha workflow support

* [ci:force] npm publish target

* fix js-api test linting

* [ci:force] fix test linting, mocks, https scheme

* [ci:force] fix https scheme

* [ci:force] typescript mappings

* [ci:force] update scripts

* lint fixes

* linting fixes

* fix linting

* [ci:force] linting fixes

* linting fixes

* [ci:force] remove js-api upstream and corresponding scripts

* [ci:force] jsdoc fixes

* fix jsdoc linting

* [ci:force] jsdoc fixes

* [ci:force] jsdoc fixes

* jsdoc fixes

* jsdoc fixes

* jsdoc fixes

* [ci:force] fix jsdoc

* [ci:force] reduce code duplication

* replace 'chai' expect with node.js assert

* replace 'chai' expect with node.js assert

* [ci:force] remove chai and chai-spies for js-api testing

* [ci:force] cleanup and fix imports

* [ci:force] fix linting

* [ci:force] fix unit test

* [ci:force] fix sonar linting findings

* [ci:force] switch activiti api models to interfaces (-2.5% reduction of bundle)

* [ci:force] switch activiti api models to interfaces

* [ci:force] switch AGS api models to interfaces

* [ci:force] switch AGS api models to interfaces

* [ci:force] switch search api models to interfaces

* [ci:force] switch content api models to interfaces where applicable
2023-11-21 05:27:51 -05:00

137 lines
4.0 KiB
Markdown

# DecisionTablesApi
All URIs are relative to */activiti-app/api*
| Method | HTTP request | Description |
|-----------------------------------------------------------|----------------------------------------------------------------------------|-------------------------------------|
| [getDecisionTableEditorJson](#getDecisionTableEditorJson) | **GET** /enterprise/decisions/decision-tables/{decisionTableId}/editorJson | Get definition for a decision table |
| [getDecisionTable](#getDecisionTable) | **GET** /enterprise/decisions/decision-tables/{decisionTableId} | Get a decision table |
| [getDecisionTables](#getDecisionTables) | **GET** /enterprise/decisions/decision-tables | Query decision tables |
# getDecisionTableEditorJson
Get definition for a decision table
**Parameters**
| Name | Type |
|---------------------|--------|
| **decisionTableId** | number |
**Return type**: [JsonNode](#JsonNode)
**Example**
```javascript
import { AlfrescoApi, DecisionTablesApi } from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*..*/);
const decisionTablesApi = new DecisionTablesApi(alfrescoApi);
const decisionTableId = 0;
decisionTablesApi.getDecisionTableEditorJson(decisionTableId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
});
```
# getDecisionTable
Get a decision table
**Parameters**
| Name | Type |
|---------------------|--------|
| **decisionTableId** | number |
**Return type**: [RuntimeDecisionTableRepresentation](RuntimeDecisionTableRepresentation.md)
**Example**
```javascript
import { AlfrescoApi, DecisionTablesApi } from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*..*/);
const decisionTablesApi = new DecisionTablesApi(alfrescoApi);
const decisionTableId = 0;
decisionTablesApi.getDecisionTable(decisionTableId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
});
```
# getDecisionTables
Query decision tables
**Parameters**
| Name | Type |
|--------------|--------|
| nameLike | string |
| keyLike | string |
| tenantIdLike | string |
| deploymentId | number |
| sort | string |
| order | string |
| start | number |
| size | number |
**Return type**: [ResultListDataRepresentationRuntimeDecisionTableRepresentation](ResultListDataRepresentationRuntimeDecisionTableRepresentation.md)
**Example**
```javascript
import { AlfrescoApi, DecisionTablesApi } from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*..*/);
const decisionTablesApi = new DecisionTablesApi(alfrescoApi);
const opts = {};
decisionTablesApi.getDecisionTables(opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
});
```
# Models
## JsonNode
**Properties**
| Name | Type |
|---------------------|---------|
| array | boolean |
| bigDecimal | boolean |
| bigInteger | boolean |
| binary | boolean |
| boolean | boolean |
| containerNode | boolean |
| double | boolean |
| float | boolean |
| floatingPointNumber | boolean |
| int | boolean |
| integralNumber | boolean |
| long | boolean |
| missingNode | boolean |
| nodeType | string |
| null | boolean |
| number | boolean |
| object | boolean |
| pojo | boolean |
| short | boolean |
| textual | boolean |
| valueNode | boolean |
### JsonNode.NodeTypeEnum
* `ARRAY` (value: `'ARRAY'`)
* `BINARY` (value: `'BINARY'`)
* `BOOLEAN` (value: `'BOOLEAN'`)
* `MISSING` (value: `'MISSING'`)
* `NULL` (value: `'NULL'`)
* `NUMBER` (value: `'NUMBER'`)
* `OBJECT` (value: `'OBJECT'`)
* `POJO` (value: `'POJO'`)
* `STRING` (value: `'STRING'`)