mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
ea2c0ce229
* 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
7.0 KiB
7.0 KiB
IntegrationboxApi
All URIs are relative to /activiti-app/api
| Method | HTTP request | Description |
|---|---|---|
| confirmAuthorisation | GET /enterprise/integration/box/confirm-auth-request | Box Authorization |
| createRepositoryAccount | POST /enterprise/integration/box/{userId}/account | Add Box account |
| deleteRepositoryAccount | DELETE /enterprise/integration/box/{userId}/account | Delete account information |
| getBoxPluginStatus | GET /enterprise/integration/box/status | Get status information |
| getFiles | GET /enterprise/integration/box/files | List file and folders |
| getRepositoryAccount | GET /enterprise/integration/box/{userId}/account | Get account information |
| updateRepositoryAccount | PUT /enterprise/integration/box/{userId}/account | Update account information |
confirmAuthorisation
confirmAuthorisation()
Box Authorization
Returns Box OAuth HTML Page
Example
import IntegrationboxApi from 'src/api/activiti-rest-api/docs/IntegrationBoxApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let integrationboxApi = new IntegrationboxApi(this.alfrescoApi);
integrationboxApi.confirmAuthorisation().then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
Parameters
This endpoint does not need any parameter.
Return type
null (empty response body)
createRepositoryAccount
createRepositoryAccount(userIdcredentials)
Add Box account
Example
import IntegrationboxApi from 'src/api/activiti-rest-api/docs/IntegrationBoxApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let integrationboxApi = new IntegrationboxApi(this.alfrescoApi);
integrationboxApi.createRepositoryAccount(userIdcredentials).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userId | number | userId | |
| credentials | UserAccountCredentialsRepresentation | credentials |
Return type
null (empty response body)
deleteRepositoryAccount
deleteRepositoryAccount(userId)
Delete account information
Example
import IntegrationboxApi from 'src/api/activiti-rest-api/docs/IntegrationBoxApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let integrationboxApi = new IntegrationboxApi(this.alfrescoApi);
integrationboxApi.deleteRepositoryAccount(userId).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userId | number | userId |
Return type
null (empty response body)
getBoxPluginStatus
boolean getBoxPluginStatus()
Get status information
Example
import IntegrationboxApi from 'src/api/activiti-rest-api/docs/IntegrationBoxApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let integrationboxApi = new IntegrationboxApi(this.alfrescoApi);
integrationboxApi.getBoxPluginStatus().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
boolean
getFiles
ResultListDataRepresentationBoxContent getFiles(opts)
List file and folders
Example
import IntegrationboxApi from 'src/api/activiti-rest-api/docs/IntegrationBoxApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let integrationboxApi = new IntegrationboxApi(this.alfrescoApi);
let opts = {
'filter': filter_example // | filter
'parent': parent_example // | parent
};
integrationboxApi.getFiles(opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| filter | string | filter | [optional] |
| parent | string | parent | [optional] |
Return type
ResultListDataRepresentationBoxContent
getRepositoryAccount
getRepositoryAccount(userId)
Get account information
Example
import IntegrationboxApi from 'src/api/activiti-rest-api/docs/IntegrationBoxApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let integrationboxApi = new IntegrationboxApi(this.alfrescoApi);
integrationboxApi.getRepositoryAccount(userId).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userId | number | userId |
Return type
null (empty response body)
updateRepositoryAccount
updateRepositoryAccount(userIdcredentials)
Update account information
Example
import IntegrationboxApi from 'src/api/activiti-rest-api/docs/IntegrationBoxApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let integrationboxApi = new IntegrationboxApi(this.alfrescoApi);
integrationboxApi.updateRepositoryAccount(userIdcredentials).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userId | number | userId | |
| credentials | UserAccountCredentialsRepresentation | credentials |
Return type
null (empty response body)