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
2.5 KiB
2.5 KiB
GroupsApi
All URIs are relative to /activiti-app/api
| Method | HTTP request | Description |
|---|---|---|
| getGroups | GET /enterprise/groups | Query groups |
| getUsersForGroup | GET /enterprise/groups/{groupId}/users | List members of a group |
getGroups
ResultListDataRepresentationLightGroupRepresentation getGroups(opts)
Query groups
Example
import GroupsApi from 'GroupsApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let groupsApi = new GroupsApi(this.alfrescoApi);
let opts = {
'filter': filter_example // | filter
'groupId': 789 // | groupId
'externalId': externalId_example // | externalId
'externalIdCaseInsensitive': externalIdCaseInsensitive_example // | externalIdCaseInsensitive
'tenantId': 789 // | tenantId
};
groupsApi.getGroups(opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| filter | string | filter | [optional] |
| groupId | number | groupId | [optional] |
| externalId | string | externalId | [optional] |
| externalIdCaseInsensitive | string | externalIdCaseInsensitive | [optional] |
| tenantId | number | tenantId | [optional] |
Return type
ResultListDataRepresentationLightGroupRepresentation
getUsersForGroup
ResultListDataRepresentationLightUserRepresentation getUsersForGroup(groupId)
List members of a group
Example
import GroupsApi from 'GroupsApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let groupsApi = new GroupsApi(this.alfrescoApi);
groupsApi.getUsersForGroup(groupId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| groupId | number | groupId |