Skip to content

Latest commit

 

History

History
314 lines (214 loc) · 7.57 KB

AdmintenantsApi.md

File metadata and controls

314 lines (214 loc) · 7.57 KB
Raw

AdmintenantsApi

All URIs are relative to https://adfdev.envalfresco.com/activiti-app/api

Method HTTP request Description
createTenant POST /enterprise/admin/tenants Create a tenant
deleteTenant DELETE /enterprise/admin/tenants/{tenantId} Delete a tenant
getTenantEvents GET /enterprise/admin/tenants/{tenantId}/events Get tenant events
getTenantLogo GET /enterprise/admin/tenants/{tenantId}/logo Get a tenant's logo
getTenant GET /enterprise/admin/tenants/{tenantId} Get a tenant
getTenants GET /enterprise/admin/tenants List tenants
update PUT /enterprise/admin/tenants/{tenantId} Update a tenant
uploadTenantLogo POST /enterprise/admin/tenants/{tenantId}/logo Update a tenant's logo

createTenant

LightTenantRepresentation createTenant(createTenantRepresentation)

Create a tenant

Only a tenant manager may access this endpoint

Example

import AdmintenantsApi from 'AdmintenantsApi';
import { AlfrescoApi } from 'alfresco-js-api';

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

let admintenantsApi = new AdmintenantsApi(this.alfrescoApi);


admintenantsApi.createTenant(createTenantRepresentation).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
createTenantRepresentation CreateTenantRepresentation createTenantRepresentation

Return type

LightTenantRepresentation

deleteTenant

deleteTenant(tenantId)

Delete a tenant

Example

import AdmintenantsApi from 'AdmintenantsApi';
import { AlfrescoApi } from 'alfresco-js-api';

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

let admintenantsApi = new AdmintenantsApi(this.alfrescoApi);


admintenantsApi.deleteTenant(tenantId).then(() => {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
tenantId number tenantId

Return type

null (empty response body)

getTenantEvents

TenantEvent getTenantEvents(tenantId)

Get tenant events

Example

import AdmintenantsApi from 'AdmintenantsApi';
import { AlfrescoApi } from 'alfresco-js-api';

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

let admintenantsApi = new AdmintenantsApi(this.alfrescoApi);


admintenantsApi.getTenantEvents(tenantId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
tenantId number tenantId

Return type

TenantEvent

getTenantLogo

getTenantLogo(tenantId)

Get a tenant's logo

Example

import AdmintenantsApi from 'AdmintenantsApi';
import { AlfrescoApi } from 'alfresco-js-api';

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

let admintenantsApi = new AdmintenantsApi(this.alfrescoApi);


admintenantsApi.getTenantLogo(tenantId).then(() => {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
tenantId number tenantId

Return type

null (empty response body)

getTenant

TenantRepresentation getTenant(tenantId)

Get a tenant

Example

import AdmintenantsApi from 'AdmintenantsApi';
import { AlfrescoApi } from 'alfresco-js-api';

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

let admintenantsApi = new AdmintenantsApi(this.alfrescoApi);


admintenantsApi.getTenant(tenantId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
tenantId number tenantId

Return type

TenantRepresentation

getTenants

LightTenantRepresentation getTenants()

List tenants

Only a tenant manager may access this endpoint

Example

import AdmintenantsApi from 'AdmintenantsApi';
import { AlfrescoApi } from 'alfresco-js-api';

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

let admintenantsApi = new AdmintenantsApi(this.alfrescoApi);

admintenantsApi.getTenants().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

LightTenantRepresentation

update

TenantRepresentation update(tenantIdcreateTenantRepresentation)

Update a tenant

Example

import AdmintenantsApi from 'AdmintenantsApi';
import { AlfrescoApi } from 'alfresco-js-api';

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

let admintenantsApi = new AdmintenantsApi(this.alfrescoApi);


admintenantsApi.update(tenantIdcreateTenantRepresentation).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
tenantId number tenantId
createTenantRepresentation CreateTenantRepresentation createTenantRepresentation

Return type

TenantRepresentation

uploadTenantLogo

ImageUploadRepresentation uploadTenantLogo(tenantIdfile)

Update a tenant's logo

Example

import AdmintenantsApi from 'AdmintenantsApi';
import { AlfrescoApi } from 'alfresco-js-api';

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

let admintenantsApi = new AdmintenantsApi(this.alfrescoApi);


admintenantsApi.uploadTenantLogo(tenantIdfile).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
tenantId number tenantId
file Blob file

Return type

ImageUploadRepresentation