Skip to content

Latest commit

 

History

History
211 lines (145 loc) · 6.81 KB

IntegrationalfrescoonpremiseApi.md

File metadata and controls

211 lines (145 loc) · 6.81 KB
Raw

IntegrationalfrescoonpremiseApi

All URIs are relative to https://adfdev.envalfresco.com/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 '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 '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 '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 '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 '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