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

3.3 KiB

SecurityControlSettingsApi

All URIs are relative to https://localhost/alfresco/api/-default-/public/gs/versions/1

Method HTTP request Description
getSecurityControlSetting GET /security-control-settings/{securityControlSettingKey} Get security control setting value
updateSecurityControlSetting PUT /security-control-settings/{securityControlSettingKey} Update security control setting value

getSecurityControlSetting

SecurityControlSettingEntry getSecurityControlSetting(securityControlSettingKey)

Get security control setting value

Gets the value for a selected securityControlSettingKey.

Example

import SecurityControlSettingsApi from 'SecurityControlSettingsApi';
import { AlfrescoApi } from '@alfresco/js-api';

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

let securitycontrolsettingsApi = new SecurityControlSettingsApi(this.alfrescoApi);


securitycontrolsettingsApi.getSecurityControlSetting(securityControlSettingKey).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
securityControlSettingKey string The key for the security control setting. You can use one of the following settings:
  • -declassificationTimeFrame- for the declassification time frame value set in alfresco-global.properties file |

Return type

SecurityControlSettingEntry

updateSecurityControlSetting

SecurityControlSettingEntry updateSecurityControlSetting(securityControlSettingKeysecurityControlSettingValue)

Update security control setting value

Updates the value of a selected securityControlSettingKey.

Example

import SecurityControlSettingsApi from 'SecurityControlSettingsApi';
import { AlfrescoApi } from '@alfresco/js-api';

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

let securitycontrolsettingsApi = new SecurityControlSettingsApi(this.alfrescoApi);


securitycontrolsettingsApi.updateSecurityControlSetting(securityControlSettingKeysecurityControlSettingValue).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
securityControlSettingKey string The key for the security control setting. You can use one of the following settings:
  • -declassificationTimeFrame- for the declassification time frame value set in alfresco-global.properties file | securityControlSettingValue | SecurityControlSettingBody| The new value for the security control setting. This can be a string or number, depending on the setting key. |

Return type

SecurityControlSettingEntry