[REST 1.1] Teams
- Marcin Wikarski (Unlicensed)
- Damian Karbownik (Unlicensed)
- Łukasz Modzelewski (Unlicensed)
- Dominika Gromak
- 1 GET
- 1.1 Get teams list
- 1.2 Get single team
- 1.3 Get team members
- 2 POST
- 2.1 Create team
- 2.2 Add member to team
- 3 PATCH
- 3.1 Update team
- 4 DELETE
GET
Get teams list
Get list of all teams.
Permissions: ADMIN USER SUPERVISOR HR
GET {jira_baseurl}/rest/vacation-manager/1.0/teamResponses: 200 500
Get single team
Get information about existing team members.
Permissions: ADMIN USER SUPERVISOR HR
Responses: 200 404 500
Path params
Name | Type | Description |
|---|---|---|
teamId | int | Team ID |
Get team members
Get information about existing team.
Permissions: ADMIN USER SUPERVISOR HR
Responses: 200 400 500
Path params
Name | Type | Description |
|---|---|---|
teamId | int | Team ID |
POST
Create team
Creates new team.
Permissions: ADMIN USER SUPERVISOR HR
Responses: 201 400 500
JSON body fields
Name | Type | Description |
|---|---|---|
name | String | Team name, must be unique for each team |
description | String (Optional) | Team description |
Add member to team
Add member to team.
Permissions: ADMIN USER SUPERVISOR HR
Responses: 201 400 404 500
Path params
Name | Type | Description |
|---|---|---|
teamId | int | Team id |
JSON body fields
Name | Type | Description |
|---|---|---|
type | MemberType | Type of member |
name | String | Name of the member you want to add to the team |
role | MemberRole | Role for member |
MemberType
Name | Type | Description |
|---|---|---|
USER | Enum | User type |
GROUP | Enum | Group type |
MemberRole
Name | Type | Description |
|---|---|---|
USER | Enum | User role for member |
SUPERVISOR | Enum | Supervisor role for member |
PATCH
Update team
Update existing team.
Permissions: ADMIN USER SUPERVISOR HR
Responses: 200 400 404 500
Path params
Name | Type | Description |
|---|---|---|
teamId | int | Team ID |
JSON body fields
Name | Type | Description |
|---|---|---|
name | String | Team name, must be unique |
description | String (Optional) | Team description |
allowUsersViewStatistics | bool (Optional) | as name says, it’s boolean value that can be either true or false, |
defaultSupervisorId | int (Optional) | ID (number value - not user name!) of a user that will be set as default supervisor, -1 means that this value will be cleared and default supervisor will be removed from team. |
DELETE
Delete team
Delete existing team.
Permissions: ADMIN USER SUPERVISOR HR
Responses: 204 404 500
Path params
Name | Type | Description |
|---|---|---|
teamId | int | Team ID |
Remove member from team
Remove member from team.
Permissions: ADMIN USER SUPERVISOR HR
Responses: 204 404 500
Path params
Name | Type | Description |
|---|---|---|
teamId | int | Team ID |
JSON body fields
Name | Type | Description |
|---|---|---|
type | String | Type of member to remove
|
name | String | Name of the member you want to remove from the team |
role | String | Role for member to remove
|
Feel free to tell us what topic should be covered: vacationmanager@psc-software.atlassian.net