list subprojecttree
/members/{member}/projects/{group}/subprojecttree [GET]
API Support | Available since | Last updated | Output |
---|---|---|---|
4.9100 | 5.9500 | xml, json |
Description
List the sub-projects the member is registered to (as a tree).
Returns the list of projects and groups for the given member.
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.
Note that the admin group is not included.
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) [member|server ] | no | enum | 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 in the entire tree | no | integer | 1000 |
Permission
This service is public, anyone can invoke it.
Response
The returned XML is as follows with <project>
at the top if a context project is specified:
<project id="[id]" name="[name]" owner="[owner]" description="[description]" ...> <!-- 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> ... <!-- groups --> <group id="[id]" name="[name]" description="[description]" owner="[owner]" ...> <group id="[id]" name="[name]" description="[description]" owner="[owner]" ...> ... </project>
Error Handling
No specific errors expected for this service.