inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
alfresco-ng2-components/lib/js-api/src/api/activiti-rest-api/docs/IntegrationAlfrescoOnPremiseApi.md
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

7.0 KiB
Raw Blame History

IntegrationalfrescoonpremiseApi

All URIs are relative to /activiti-app/api

Method HTTP request Description
getAllSites GET /enterprise/integration/alfresco/{repositoryId}/sites List Alfresco sites
getContentInFolderPath GET /enterprise/rest/integration/alfresco/{repositoryId}/sites/{siteId}/folderpath/{folderPath}/content List files and folders inside a specific folder identified by folder path
getContentInFolder GET /enterprise/integration/alfresco/{repositoryId}/folders/{folderId}/content List files and folders inside a specific folder
getContentInSite GET /enterprise/integration/alfresco/{repositoryId}/sites/{siteId}/content List files and folders inside a specific site
getRepositories GET /enterprise/profile/accounts/alfresco List Alfresco repositories

getAllSites

ResultListDataRepresentationAlfrescoSiteRepresenation getAllSites(repositoryId)

List Alfresco sites

Returns ALL Sites

Example

import IntegrationalfrescoonpremiseApi from 'src/api/activiti-rest-api/docs/IntegrationAlfrescoOnPremiseApi';
import {AlfrescoApi} from '@alfresco/js-api';

this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
    hostEcm: 'http://127.0.0.1:8080'
});

let integrationalfrescoonpremiseApi = new IntegrationalfrescoonpremiseApi(this.alfrescoApi);


integrationalfrescoonpremiseApi.getAllSites(repositoryId).then((data) => {
    console.log('API called successfully. Returned data: ' + data);
}, function (error) {
    console.error(error);
});

Parameters

Name Type Description Notes
repositoryId string repositoryId

Return type

ResultListDataRepresentationAlfrescoSiteRepresenation

getContentInFolderPath

ResultListDataRepresentationAlfrescoContentRepresentation getContentInFolderPath(repositoryIdsiteIdfolderPath)

List files and folders inside a specific folder identified by folder path

Example

import IntegrationalfrescoonpremiseApi from 'src/api/activiti-rest-api/docs/IntegrationAlfrescoOnPremiseApi';
import {AlfrescoApi} from '@alfresco/js-api';

this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
    hostEcm: 'http://127.0.0.1:8080'
});

let integrationalfrescoonpremiseApi = new IntegrationalfrescoonpremiseApi(this.alfrescoApi);


integrationalfrescoonpremiseApi.getContentInFolderPath(repositoryIdsiteIdfolderPath).then((data) => {
    console.log('API called successfully. Returned data: ' + data);
}, function (error) {
    console.error(error);
});

Parameters

Name Type Description Notes
repositoryId string repositoryId
siteId string siteId
folderPath string folderPath

Return type

ResultListDataRepresentationAlfrescoContentRepresentation

getContentInFolder

ResultListDataRepresentationAlfrescoContentRepresentation getContentInFolder(repositoryIdfolderId)

List files and folders inside a specific folder

Example

import IntegrationalfrescoonpremiseApi from 'src/api/activiti-rest-api/docs/IntegrationAlfrescoOnPremiseApi';
import {AlfrescoApi} from '@alfresco/js-api';

this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
    hostEcm: 'http://127.0.0.1:8080'
});

let integrationalfrescoonpremiseApi = new IntegrationalfrescoonpremiseApi(this.alfrescoApi);


integrationalfrescoonpremiseApi.getContentInFolder(repositoryIdfolderId).then((data) => {
    console.log('API called successfully. Returned data: ' + data);
}, function (error) {
    console.error(error);
});

Parameters

Name Type Description Notes
repositoryId string repositoryId
folderId string folderId

Return type

ResultListDataRepresentationAlfrescoContentRepresentation

getContentInSite

ResultListDataRepresentationAlfrescoContentRepresentation getContentInSite(repositoryIdsiteId)

List files and folders inside a specific site

Example

import IntegrationalfrescoonpremiseApi from 'src/api/activiti-rest-api/docs/IntegrationAlfrescoOnPremiseApi';
import {AlfrescoApi} from '@alfresco/js-api';

this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
    hostEcm: 'http://127.0.0.1:8080'
});

let integrationalfrescoonpremiseApi = new IntegrationalfrescoonpremiseApi(this.alfrescoApi);


integrationalfrescoonpremiseApi.getContentInSite(repositoryIdsiteId).then((data) => {
    console.log('API called successfully. Returned data: ' + data);
}, function (error) {
    console.error(error);
});

Parameters

Name Type Description Notes
repositoryId string repositoryId
siteId string siteId

Return type

ResultListDataRepresentationAlfrescoContentRepresentation

getRepositories

ResultListDataRepresentationAlfrescoEndpointRepresentation getRepositories(opts)

List Alfresco repositories

A tenant administrator can configure one or more Alfresco repositories to use when working with content.

Example

import IntegrationalfrescoonpremiseApi from 'src/api/activiti-rest-api/docs/IntegrationAlfrescoOnPremiseApi';
import {AlfrescoApi} from '@alfresco/js-api';

this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
    hostEcm: 'http://127.0.0.1:8080'
});

let integrationalfrescoonpremiseApi = new IntegrationalfrescoonpremiseApi(this.alfrescoApi);

let opts = {
    'tenantId': 789 //  | tenantId
    'includeAccounts': true //  | includeAccounts
};

integrationalfrescoonpremiseApi.getRepositories(opts).then((data) => {
    console.log('API called successfully. Returned data: ' + data);
}, function (error) {
    console.error(error);
});

Parameters

Name Type Description Notes
tenantId number tenantId [optional]
includeAccounts boolean includeAccounts [optional] [default to true]

Return type

ResultListDataRepresentationAlfrescoEndpointRepresentation