mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[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
This commit is contained in:
@@ -0,0 +1,97 @@
|
||||
# DecisionAuditsApi
|
||||
|
||||
All URIs are relative to */activiti-app/api*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
|-----------------------------------|-----------------------------------------------------|-----------------------------------|
|
||||
| [getAuditTrail](#getAuditTrail) | **GET** /enterprise/decisions/audits/{auditTrailId} | Get an audit trail |
|
||||
| [getAuditTrails](#getAuditTrails) | **GET** /enterprise/decisions/audits | Query decision table audit trails |
|
||||
|
||||
# getAuditTrail
|
||||
|
||||
Get an audit trail
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type |
|
||||
|------------------|--------|
|
||||
| **auditTrailId** | number |
|
||||
|
||||
**Return type**: [DecisionAuditRepresentation](#DecisionAuditRepresentation)
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
import { AlfrescoApi, DecisionAuditsApi } from '@alfresco/js-api';
|
||||
|
||||
const alfrescoApi = new AlfrescoApi(/*..*/);
|
||||
const decisionAuditsApi = new DecisionAuditsApi(this.alfrescoApi);
|
||||
const auditTrailId = 0;
|
||||
|
||||
decisionauditsApi.getAuditTrail(auditTrailId).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
});
|
||||
```
|
||||
|
||||
# getAuditTrails
|
||||
|
||||
Query decision table audit trails
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type |
|
||||
|---------------------|--------|
|
||||
| **decisionKey** | string |
|
||||
| **dmnDeploymentId** | number |
|
||||
|
||||
**Return type**: [ResultListDataRepresentationDecisionAuditRepresentation](#ResultListDataRepresentationDecisionAuditRepresentation)
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
import { AlfrescoApi, DecisionAuditsApi } from '@alfresco/js-api';
|
||||
|
||||
const alfrescoApi = new AlfrescoApi(/*..*/);
|
||||
const decisionAuditsApi = new DecisionAuditsApi(this.alfrescoApi);
|
||||
const dmnDeploymentId = 0;
|
||||
|
||||
decisionauditsApi.getAuditTrails(`<decisionKey>`, dmnDeploymentId).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
});
|
||||
```
|
||||
|
||||
# Models
|
||||
|
||||
## ResultListDataRepresentationDecisionAuditRepresentation
|
||||
|
||||
**Properties**
|
||||
|
||||
| Name | Type |
|
||||
|-------|---------------------------------------------------------------|
|
||||
| data | [DecisionAuditRepresentation[]](#DecisionAuditRepresentation) |
|
||||
| size | number |
|
||||
| start | number |
|
||||
| total | number |
|
||||
|
||||
## DecisionAuditRepresentation
|
||||
|
||||
**Properties**
|
||||
|
||||
| Name | Type |
|
||||
|-------------------------|---------|
|
||||
| activityId | string |
|
||||
| activityName | string |
|
||||
| auditTrailJson | string |
|
||||
| created | Date |
|
||||
| decisionExecutionFailed | boolean |
|
||||
| decisionKey | string |
|
||||
| decisionModelJson | string |
|
||||
| decisionName | string |
|
||||
| dmnDeploymentId | number |
|
||||
| executionId | string |
|
||||
| id | number |
|
||||
| processDefinitionId | string |
|
||||
| processInstanceId | string |
|
||||
| renderedVariables | any |
|
||||
|
||||
|
Reference in New Issue
Block a user