Obsolete Pages{{Obsolete}}
The official documentation is at: http://docs.alfresco.com
Note: All returned data will be contained in the standard JSON return structure:
{
'data' : <resulting JSON data structure goes here>
}
A group contains the following:
For future enhancements (More thought required here)
JSON example:
{
'shortName' : 'myGroup',
'fullName' : 'GROUP_myGroup',
'displayName' : 'My Group',
'userCount' : 2,
'groupCount' : 3,
'isRootGroup' : true,
'authorityType' : 'Group',
'url' : '/api/groups/myGroup'
}
The resource to represent the collection all root groups.
Methods:
List all the root groups:
GET /api/rootgroups
?includeInternal={includeInternal?}
Create a root group(s):
POST /api/rootgroups
=> Groups[]
Resource to represent the collection of all groups.
Methods:
Search groups by short name.
If a shortNameFilter value is provided only groups that contain the string in their short names will be returned.
Mrogers 11:05, 30 March 2009 (BST) should we allow regex here?
GET /api/groups
?shortNameFilter={shortNameFilter?}&includeInternal={includeInternal?}
Resource to represent a group.
Methods:
Get the details of a group:
GET /api/groups/{shortName}
Update the details of a group:
PUT /api/groups/{shortName}
=> Group
Delete a group and all it's dependants:
DELETE /api/groups/{shortName}
Resource to represent the child users/groups of a group.
Methods:
Get a list of the child authorities of a group. This contains both people and groups. The authority type parameter can be used to only return authorities of the given type.
GET /api/groups/{shortName}/children
?authorityType={authorityType?}
Adds group(s) and user(s) as children of a group. If the provided group does not exist it is created.
POST /api/groups/{shortName}/children
=> (Group|Person)[]
Resource to represent a child user/group of a group.
Methods:
Removes a person or group from a group. The id is either the a user id or a group short name.
DELETE /api/groups/{shortName}/children/{id}
Resource to represent the parent groups of this group.
Methods:
Get a list of the parent groups of this parent.
GET /api/groups/{shortName}/parents?level='ALL'
Add the following values to the Person data:
Ask for and offer help to other Alfresco Content Services Users and members of the Alfresco team.
Related links:
By using this site, you are agreeing to allow us to collect and use cookies as outlined in Alfresco’s Cookie Statement and Terms of Use (and you have a legitimate interest in Alfresco and our products, authorizing us to contact you in such methods). If you are not ok with these terms, please do not use this website.