list subprojecttree

Description

List the groups and subprojects of the context project for either the specified member or the whole server. The context project is specified by the {group} parameter in the service URL.

This service returns the list of groups and projects in hierarchical form so that subprojects and groups appear nested correctly within the specified project.

This service is similar to the /members/{member}/projecttree service, the main difference is that this service returns only the context project and its children.

Parameters

archived

By default, this service only returns memberships to groups and projects which are not archived.

If the context project is archived (starts with archive- ), use archived=true to list the groups and projects within that project.

for

This service returns the groups that the specified member is a member of, including subgroups.

If you are an administrator, you can use for=server to return all the projects and groups for the server under the context project specified by {group} in the service URL.

groups

This parameter controls whether groups are returned in the response.

If your PageSeeder instance contains many projects or groups, setting this parameter to false lets you load the project tree structure gradually.

nameprefix

This parameter filters the results by only returning the projects and groups which name matches the specified prefix.

If specified, the nameprefix must match the {group} specified in the project URL.

resultsize

This parameter limits the number of groups and projects which are returned. The maximum value allowed is 10000.

Permission

Any member can invoke this service for themselves.

Only an administrator can request the project trees for the entire server with for=server. or for another member.

Response

The returned XML is as follows with <project> at the top:

<project 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]" ... />
    ...
  </project>
  ...

  <!-- groups -->
  <group id="[id]" name="[name]" description="[description]" owner="[owner]" ... />
  <group id="[id]" name="[name]" description="[description]" owner="[owner]" ... />
  ...
</project>

Or in JSON

{
  "id": number,
  "name": string,
  "owner": string,
  "type": string,
  "description": string,
  "groups: [
    ...
  ]
}

In JSON, use the type property to distinguish groups from projects. The groups array property is only specified if type is project.

Error Handling