mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-31 17:38:48 +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,91 @@
|
||||
# ModelshistoryApi
|
||||
|
||||
All URIs are relative to */activiti-app/api*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**getModelHistoryCollection**](ModelsHistoryApi.md#getModelHistoryCollection) | **GET** /enterprise/models/{modelId}/history | List a model's historic versions
|
||||
[**getProcessModelHistory**](ModelsHistoryApi.md#getProcessModelHistory) | **GET** /enterprise/models/{modelId}/history/{modelHistoryId} | Get a historic version of a model
|
||||
|
||||
|
||||
<a name="getModelHistoryCollection"></a>
|
||||
# **getModelHistoryCollection**
|
||||
> ResultListDataRepresentationModelRepresentation getModelHistoryCollection(modelIdopts)
|
||||
|
||||
List a model's historic versions
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import ModelshistoryApi from 'src/api/activiti-rest-api/docs/ModelsHistoryApi';
|
||||
import {AlfrescoApi} from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let modelshistoryApi = new ModelshistoryApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'includeLatestVersion': true // | includeLatestVersion
|
||||
};
|
||||
|
||||
modelshistoryApi.getModelHistoryCollection(modelIdopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function (error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**modelId** | **number**| modelId |
|
||||
**includeLatestVersion** | **boolean**| includeLatestVersion | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ResultListDataRepresentationModelRepresentation**](ResultListDataRepresentationModelRepresentation.md)
|
||||
|
||||
<a name="getProcessModelHistory"></a>
|
||||
# **getProcessModelHistory**
|
||||
> ModelRepresentation getProcessModelHistory(modelIdmodelHistoryId)
|
||||
|
||||
Get a historic version of a model
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import ModelshistoryApi from 'src/api/activiti-rest-api/docs/ModelsHistoryApi';
|
||||
import {AlfrescoApi} from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let modelshistoryApi = new ModelshistoryApi(this.alfrescoApi);
|
||||
|
||||
|
||||
modelshistoryApi.getProcessModelHistory(modelIdmodelHistoryId).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function (error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**modelId** | **number**| modelId |
|
||||
**modelHistoryId** | **number**| modelHistoryId |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ModelRepresentation**](ModelRepresentation.md)
|
||||
|
Reference in New Issue
Block a user