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:
Denys Vuika
GitHub
@@ -0,0 +1,250 @@
|
||||
# IntegrationalfrescocloudApi
|
||||
|
||||
All URIs are relative to */activiti-app/api*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**confirmAuthorisation**](IntegrationAlfrescoCloudApi.md#confirmAuthorisation) | **GET** /enterprise/integration/alfresco-cloud/confirm-auth-request | Alfresco Cloud Authorization
|
||||
[**getAllNetworks**](IntegrationAlfrescoCloudApi.md#getAllNetworks) | **GET** /enterprise/integration/alfresco-cloud/networks | List Alfresco networks
|
||||
[**getAllSites**](IntegrationAlfrescoCloudApi.md#getAllSites) | **GET** /enterprise/integration/alfresco-cloud/networks/{networkId}/sites | List Alfresco sites
|
||||
[**getContentInFolderPath**](IntegrationAlfrescoCloudApi.md#getContentInFolderPath) | **GET** /enterprise/integration/alfresco-cloud/networks/{networkId}/sites/{siteId}/folderpath/{folderPath}/content | List files and folders inside a specific folder identified by path
|
||||
[**getContentInFolder**](IntegrationAlfrescoCloudApi.md#getContentInFolder) | **GET** /enterprise/integration/alfresco-cloud/networks/{networkId}/folders/{folderId}/content | List files and folders inside a specific folder
|
||||
[**getContentInSite**](IntegrationAlfrescoCloudApi.md#getContentInSite) | **GET** /enterprise/integration/alfresco-cloud/networks/{networkId}/sites/{siteId}/content | List files and folders inside a specific site
|
||||
|
||||
|
||||
<a name="confirmAuthorisation"></a>
|
||||
# **confirmAuthorisation**
|
||||
> confirmAuthorisation(code)
|
||||
|
||||
Alfresco Cloud Authorization
|
||||
|
||||
Returns Alfresco OAuth HTML Page
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import IntegrationalfrescocloudApi from 'src/api/activiti-rest-api/docs/IntegrationAlfrescoCloudApi';
|
||||
import {AlfrescoApi} from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let integrationalfrescocloudApi = new IntegrationalfrescocloudApi(this.alfrescoApi);
|
||||
|
||||
|
||||
integrationalfrescocloudApi.confirmAuthorisation(code).then(() => {
|
||||
console.log('API called successfully.');
|
||||
}, function (error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**code** | **string**| code |
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
<a name="getAllNetworks"></a>
|
||||
# **getAllNetworks**
|
||||
> ResultListDataRepresentationAlfrescoNetworkRepresenation getAllNetworks()
|
||||
|
||||
List Alfresco networks
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import IntegrationalfrescocloudApi from 'src/api/activiti-rest-api/docs/IntegrationAlfrescoCloudApi';
|
||||
import {AlfrescoApi} from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let integrationalfrescocloudApi = new IntegrationalfrescocloudApi(this.alfrescoApi);
|
||||
|
||||
integrationalfrescocloudApi.getAllNetworks().then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function (error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**ResultListDataRepresentationAlfrescoNetworkRepresenation**](ResultListDataRepresentationAlfrescoNetworkRepresenation.md)
|
||||
|
||||
<a name="getAllSites"></a>
|
||||
# **getAllSites**
|
||||
> ResultListDataRepresentationAlfrescoSiteRepresenation getAllSites(networkId)
|
||||
|
||||
List Alfresco sites
|
||||
|
||||
Returns ALL Sites
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import IntegrationalfrescocloudApi from 'src/api/activiti-rest-api/docs/IntegrationAlfrescoCloudApi';
|
||||
import {AlfrescoApi} from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let integrationalfrescocloudApi = new IntegrationalfrescocloudApi(this.alfrescoApi);
|
||||
|
||||
|
||||
integrationalfrescocloudApi.getAllSites(networkId).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function (error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**networkId** | **string**| networkId |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ResultListDataRepresentationAlfrescoSiteRepresenation**](ResultListDataRepresentationAlfrescoSiteRepresenation.md)
|
||||
|
||||
<a name="getContentInFolderPath"></a>
|
||||
# **getContentInFolderPath**
|
||||
> ResultListDataRepresentationAlfrescoContentRepresentation getContentInFolderPath(networkIdopts)
|
||||
|
||||
List files and folders inside a specific folder identified by path
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import IntegrationalfrescocloudApi from 'src/api/activiti-rest-api/docs/IntegrationAlfrescoCloudApi';
|
||||
import {AlfrescoApi} from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let integrationalfrescocloudApi = new IntegrationalfrescocloudApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'siteId': siteId_example // | siteId
|
||||
'path': path_example // | path
|
||||
};
|
||||
|
||||
integrationalfrescocloudApi.getContentInFolderPath(networkIdopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function (error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**networkId** | **string**| networkId |
|
||||
**siteId** | **string**| siteId | [optional]
|
||||
**path** | **string**| path | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ResultListDataRepresentationAlfrescoContentRepresentation**](ResultListDataRepresentationAlfrescoContentRepresentation.md)
|
||||
|
||||
<a name="getContentInFolder"></a>
|
||||
# **getContentInFolder**
|
||||
> ResultListDataRepresentationAlfrescoContentRepresentation getContentInFolder(networkIdfolderId)
|
||||
|
||||
List files and folders inside a specific folder
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import IntegrationalfrescocloudApi from 'src/api/activiti-rest-api/docs/IntegrationAlfrescoCloudApi';
|
||||
import {AlfrescoApi} from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let integrationalfrescocloudApi = new IntegrationalfrescocloudApi(this.alfrescoApi);
|
||||
|
||||
|
||||
integrationalfrescocloudApi.getContentInFolder(networkIdfolderId).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function (error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**networkId** | **string**| networkId |
|
||||
**folderId** | **string**| folderId |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ResultListDataRepresentationAlfrescoContentRepresentation**](ResultListDataRepresentationAlfrescoContentRepresentation.md)
|
||||
|
||||
<a name="getContentInSite"></a>
|
||||
# **getContentInSite**
|
||||
> ResultListDataRepresentationAlfrescoContentRepresentation getContentInSite(networkIdsiteId)
|
||||
|
||||
List files and folders inside a specific site
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import IntegrationalfrescocloudApi from 'src/api/activiti-rest-api/docs/IntegrationAlfrescoCloudApi';
|
||||
import {AlfrescoApi} from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let integrationalfrescocloudApi = new IntegrationalfrescocloudApi(this.alfrescoApi);
|
||||
|
||||
|
||||
integrationalfrescocloudApi.getContentInSite(networkIdsiteId).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function (error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**networkId** | **string**| networkId |
|
||||
**siteId** | **string**| siteId |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ResultListDataRepresentationAlfrescoContentRepresentation**](ResultListDataRepresentationAlfrescoContentRepresentation.md)
|
||||
|
||||
Reference in New Issue
Block a user