TheDude
/
openproject
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
OpenProject is the leading open source project management software.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
52394 Commits
139 Branches
203 Tags
1.2 GiB
Tag: Branch: Tree: 9d156c0f97
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '9d156c0f97'
${ noResults }
openproject/docs/api/apiv3/endpoints/groups.apib

68 lines
4.2 KiB
Raw Normal View History Unescape

introduce group resource stub
7 years ago
# Group Groups
Groups are collections of users. They support assigning/unassigning multiple users to/from a project in one operation.
This resource is currently a stub.
## Actions
None
## Linked Properties
Feature/members api show (#7308) * basic members collection response * complete member index end point * document versions#index * remove user association from members There is already a more generic principals association. Having both causes confusion and leads to duplicate loading of models * linting * remove disabled test * add members#show api end point * add project and principal to member representer * replace member.user reference with principal * use principal reference in project members association * modernize roles api * complete member representer rendering * replace remnants of user association * add member schema api endpoint * have dedicated available projects end point for versions * linting * limit roles to assignable ones in schema * rename member to membership in api * remove remnants of user in member * spec fixes * use available_projects endpoint in versions board * add eager loading to memberships#index * members create form api endpoint * ensure role exists for default assignment * extract switch for users/groups to work_packages representer * document membership create form * add l10n expected in specs * strengthen the usage of a delete base service * use base class for set attributes service * fix alias in service * add create endpoint to members api * document members create endpoint * linting * adapt to altered service signature * use default endpoint for wp#get * use CF infused representer [ci skip]
6 years ago
| Link | Description | Type | Constraints | Supported operations | Condition |
|:-----------:|-------------------------------------------------------------- | ------------- | --------------------- | -------------------- | ----------------------------------------- |
| self | This group | Group | not null | READ | |
| members | Link ot collection of all the group's memberships. The list will only include the memberships in projects in which the requesting user has the necessary permissions. | MemberCollection | | READ | **Permission**: view members or manage members in any project |
introduce group resource stub
7 years ago
## Local Properties
| Property | Description | Type | Constraints | Supported operations | Condition |
| :----------: | --------------------------------------------------------- | -------- | ---------------------------------------------------- | -------------------- | ----------------------------------------------------------- |
| id | Group's id | Integer | x > 0 | READ | |
| name | Group's full name, formatting depends on instance settings | String | | READ | |
| createdAt | Time of creation | DateTime | | READ | |
| updatedAt | Time of the most recent change to the user | DateTime | | READ | |
## Group [/api/v3/groups/{id}]
+ Model
+ Body
{
"_type": "Group",
"id": 9,
"name": "The group",
"createdAt": "2015-09-23T11:06:36Z",
"updatedAt": "2015-09-23T11:06:36Z",
"_links": {
"self": {
"href": "/api/v3/groups/9",
"title": "The group"
}
}
}
## View group [GET]
+ Parameters
+ id (required, integer, `1`) ... Group id.
+ Response 200 (application/hal+json)
[Group][]
+ Response 404 (application/hal+json)
Returned if the group does not exist or if the API user does not have permission to view them.
**Required permission** If the user has the *manage members* permission in at least one project the user will be able to query all groups. If not, the user
will be able to query all groups which are members in projects, he has the *view members* permission in.
+ Body
{
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:NotFound",
"message": "The requested resource could not be found."
}