list projecttree
/members/{member}/projecttree [GET]
API Support | Available since | Last updated | Output |
---|---|---|---|
4.9100 | 5.9500 | xml, json |
Description
List the projects and groups that the specified member is registered to as a tree.
This service returns the list of groups and projects in hierarchical form so that sub-projects and groups appear nested correctly within the specified project.
Parameters
Name | Description | Required | Type | Default value |
---|---|---|---|---|
archived | Whether to return archived projects/groups only | no | boolean | false |
for | If 'server', return all projects/groups for server (Administrator only) [server|member ] | no | boolean | member |
groups | Whether to return groups | no | boolean | true |
nameprefix | Prefix that project/group’s full name must have to be returned | no | string | |
resultsize | The max number of results (the tree might have more nodes as ancestors are always added) | no | integer | 1000 |
Permission
Response
The returned XML is as follows with <project>
at the top if a context project is specified (in alphabetical order by name):
<projects for="[username|email]"> <project id="[id]" name="[name]" owner="[owner]" description="[description]" ...> <!-- groups --> <group id="[id]" name="[name]" description="[description]" owner="[owner]" ...> <group id="[id]" name="[name]" description="[description]" owner="[owner]" ...> ... <!-- sub projects --> <project id="[id]" name="[name]" description="[description]" owner="[owner]" ...> <group id="[id]" name="[name]" description="[description]" owner="[owner]" ...> <group id="[id]" name="[name]" description="[description]" owner="[owner]" ...> <group id="[id]" name="[name]" description="[description]" owner="[owner]" ...> ... </project> ... </project> </projects>
Error Handling
No specific errors expected for this service.