kanbanworkflowstimelinescrumrubyroadmapproject-planningproject-managementopenprojectangularissue-trackerifcgantt-chartganttbug-trackerboardsbcf
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.
67 lines
3.5 KiB
67 lines
3.5 KiB
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
|
||
|
|
| Link | Description | Type | Constraints | Supported operations | Condition |
|
||
|
|
|:-----------:|-------------------------------------------------------------- | ------------- | --------------------- | -------------------- | ----------------------------------------- |
|
||
|
|
| self | This group | Group | not null | READ | |
|
||
|
|
|
||
|
|
## 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."
|
||
|
|
}
|
||
|
|
|