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/AdminTenantsApi.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.8 KiB
Raw Blame History

AdmintenantsApi

All URIs are relative to /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 'src/api/activiti-rest-api/docs/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 'src/api/activiti-rest-api/docs/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 'src/api/activiti-rest-api/docs/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 'src/api/activiti-rest-api/docs/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 'src/api/activiti-rest-api/docs/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 'src/api/activiti-rest-api/docs/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 'src/api/activiti-rest-api/docs/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 'src/api/activiti-rest-api/docs/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