find projects
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.6012 | 5.9700 | json, xml |
Description
Finds projects and groups for the specified member or the whole server.
When listing groups for a user, they must have a membership status of normal to the group or a subgroup. Archived groups are not included by default.
Without any parameters, this service returns all the projects and groups that the user is a member of, but does not include the membership information such as the roles, status and details. You can use the /members/{member}/memberships service to include the membership information.
Parameters
| Name | Description | Required | Type | Default value |
|---|---|---|---|---|
| archived | Whether to return archived projects/groups only (otherwise they are not included) | no | boolean | false |
| for | If 'server', return all projects/groups for server (Administrator only); If 'manager', return only projects/groups member is a manager of ( server|manager|member) | no | string | member |
| nameprefix | Prefix that project/group’s full name can have to be returned | no | string | |
| titleprefix | Prefix that project/group’s title can have to be returned | no | string | |
| page | The page to load | no | integer | 1 |
| pagesize | The number of results per page | no | integer | 1000 |
archived
By default, this service only returns groups and projects which are not archived.
Use archived=true to only list archived groups and projects.
for
This service returns the groups that the specified member is register to.
You can use for=manager to only return groups and projects where the member has a manager role.
If you are an administrator, you can also use for=server to return all the projects and groups for the server.
Since the server option can return many results, you can reduce the number of results using the nameprefix and titleprefix parameters. Consider using paging with the page and pagesize parameters also.
nameprefix
Use this parameter to only return the projects and groups with full name matching the specified prefix. The prefix matching is not case sensitive. If titleprefix is also specified, projects and groups matching that will also be returned.
The prefix matches the full name of the group only, so it must include the projects and subprojects names (for example sample-geo-australia). Consider using the titleprefix as an alternative.
titleprefix
Use this parameter to only return the projects and groups with title matching the specified prefix. The prefix matching is not case sensitive. If nameprefix is also specified, projects and groups matching that will also be returned.
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 (in alphabetical order on name):
<projects limitreached="[true]">
<project id="[id]"
name="[name]"
owner="[owner]"
description="[description]"
... />
<group id="[id]"
name="[name]"
description="[description]"
owner="[owner]"
... />
<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]"
... />
...
</projects>Or in JSON:
{
"limitreached": boolean,
"projects": [
{
"id": number,
"name": string,
"type": string,
"title": string,
"description": string,
"owner": string,
"owner": string,
"access": string,
"common": boolean
}
]
}The limitreached attribute/property is only specified when there are more results than the page size.
In JSON, use the type property to distinguish groups from projects.
Error Handling
No specific errors expected for this service.