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
4.4 KiB
4.4 KiB
SystempropertiesApi
All URIs are relative to /activiti-app/api
| Method | HTTP request | Description |
|---|---|---|
| getGlobalDateFormat | GET /enterprise/system/properties/global-date-format/{tenantId} | Get global date format |
| getPasswordValidationConstraints | GET /enterprise/system/properties/password-validation-constraints/{tenantId} | Get password validation constraints |
| getProperties | GET /enterprise/system/properties | Retrieve system properties |
| involvedUsersCanEditForms | GET /enterprise/system/properties/involved-users-can-edit-forms/{tenantId} | Get involved users who can edit forms |
getGlobalDateFormat
GlobalDateFormatRepresentation getGlobalDateFormat(tenantId)
Get global date format
Example
import SystempropertiesApi from 'src/api/activiti-rest-api/docs/SystemPropertiesApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let systempropertiesApi = new SystempropertiesApi(this.alfrescoApi);
systempropertiesApi.getGlobalDateFormat(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
GlobalDateFormatRepresentation
getPasswordValidationConstraints
PasswordValidationConstraints getPasswordValidationConstraints(tenantId)
Get password validation constraints
Example
import SystempropertiesApi from 'src/api/activiti-rest-api/docs/SystemPropertiesApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let systempropertiesApi = new SystempropertiesApi(this.alfrescoApi);
systempropertiesApi.getPasswordValidationConstraints(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
getProperties
SystemPropertiesRepresentation getProperties()
Retrieve system properties
Typical value is AllowInvolveByEmail
Example
import SystempropertiesApi from 'src/api/activiti-rest-api/docs/SystemPropertiesApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let systempropertiesApi = new SystempropertiesApi(this.alfrescoApi);
systempropertiesApi.getProperties().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
SystemPropertiesRepresentation
involvedUsersCanEditForms
boolean involvedUsersCanEditForms(tenantId)
Get involved users who can edit forms
Example
import SystempropertiesApi from 'src/api/activiti-rest-api/docs/SystemPropertiesApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let systempropertiesApi = new SystempropertiesApi(this.alfrescoApi);
systempropertiesApi.involvedUsersCanEditForms(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
boolean