Skip to main content

 Services

Web services from /about to /webhooks

list projecttree

/members/{member}/projecttree [GET]

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

NameDescriptionRequiredTypeDefault value
archivedWhether to return archived projects/groups onlynobooleanfalse
forIf 'server', return all projects/groups for server (Administrator only) [server|member]nobooleanmember
groupsWhether to return groupsnobooleantrue
nameprefixPrefix that project/group’s full name must have to be returnednostring
resultsizeThe max number of results (the tree might have more nodes as ancestors are always added)nointeger1000

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.

Created on , last edited on