Overview
Vacation Manager's REST API provides team API which allows you to obtain:
Methods:
GET
...
...
GET
Get teams list
Get list of all teams.
Permissions:
| Code Block |
|---|
GET {jira_baseurl}/rest/vacation-manager/1.0/team |
Responses:
| Expand |
|---|
|
Path | Code Block |
|---|
GET {jira_baseurl}/rest/vacation-manager/1.0/team |
Request| Code Block |
|---|
[
{
"id": 1,
"name": "team 1",
"description": "description 1"
},
{
"id": 2,
"name": "team 2",
"description": "description 2"
},
{
"id": 3,
"name": "team 3",
"description": "description 3"
}
]
|
|
Get single team
Get information about existing team members.
Permissions:
| Code Block |
|---|
GET {jira_baseurl}/rest/vacation-manager/1.0/team/{teamId} |
Responses:
Path params
Name | Type | Description |
|---|
teamId | int | Team ID |
| Expand |
|---|
|
Path| Code Block |
|---|
GET {jira_baseurl}/rest/vacation-manager/1.0/team/1 |
PermissionsResponse Responses Example| Code Block |
|---|
| GET {jira_baseurl}/rest/vacation-manager/1.0/team |
| Code Block |
|---|
| | Code Block |
|---|
{
"id": 1,
"name": "teamName",
"description": "description",
"users": [
{
"id": 1,
"name": "teamuser 1",
"descriptiondisplayName": "descriptionUser 1",
"active": true
},
{
"id": 2,
"name": "teamuser 2",
"descriptiondisplayName": "descriptionUser 2",
"active": true
},
{
"id": 3,
"name": "teamuser 3",
"descriptiondisplayName": "descriptionUser 3",
"active": true
}
]
|
|
...
| Expand |
|---|
|
Get information about existing team members. Path| Code Block |
|---|
GET {jira_baseurl}/rest/vacation-manager/1.0/team/{teamId} |
Permissions | Status |
|---|
|
| colour | Red |
|---|
title | SUPERVISOR,
"supervisors": [
{
"id": 4,
"name": "supervisor 1",
"displayName": "Supervisor 1",
"active": true
}
]
}
|
Get team members
Get information about existing team.
Permissions:
...
...
...
...
| Code Block |
|---|
GET {jira_baseurl}/rest/vacation-manager/1.0/team/{teamId}/member |
Responses:
...
Example
| Code Block |
|---|
|
GET {jira_baseurl}/rest/vacation-manager/1.0/team/1 |
...
...
Path params
Name | Type | Description |
|---|
teamId | int | Team ID |
| Expand |
|---|
|
Path| Code Block |
|---|
GET {jira_baseurl}/rest/vacation-manager/1.0/team/1/member |
Response| Code Block |
|---|
{
"id": 1,
"name": "teamName",
"description": "description",
"user": {
"users": [
{
"id": 1,
"userId": 10,
"role": "USER",
"teamId": 1
},
{
"id": 2,
"userId": 20,
"role": "USER",
"teamId": 1
},
{
"id": 3,
"userId": 30,
"role": "USER",
"teamId": 1
}
],
"groups": [
{
"id": 7,
"groupName": "users",
"role": "USER",
"teamId": 1
}
]
},
"supervisor": {
"users": [
{
"id": 4,
"userId": 40,
"role": "SUPERVISOR",
"teamId": 1
},
{
"id": 5,
"userId": 50,
"role": "SUPERVISOR",
"teamId": 1
},
{
" |
name"user 1","displayName":"User1",activetrue},{id2"name":"user2","displayName": "User 2",activetrue},{3"name": "user 3",displayNameUser 3
"active":true}],supervisors[{"id":4,"name":"supervisor1","displayName": "Supervisor 1", "active": true
}
]
}
|
...
POST
...
| Expand |
|---|
|
Creates new team. Path |
...
POST
Create team
Creates new team.
Permissions:
| Code Block |
|---|
POST {jira_baseurl}/rest/vacation-manager/1.0/teamPermissions |
Responses:
...
...
...
...
JSON body fields
Name | Type | Description |
|---|
name | String | Team name, must be unique for each team |
description | String (Optional) | Team description |
Responses
| Status |
|---|
colour | Red| Expand |
|---|
| 500 |
ExamplePath| Code Block |
|---|
title | Path |
|---|
POST {jira_baseurl}/rest/vacation-manager/1.0/team |
Body | Code Block |
|---|
title |
|---|
| Body | {
"name": "Team name",
"description": "Team Description"
} |
Response | Code Block |
|---|
title |
|---|
| Response | {
"id":
"name": "Team name",
"description": "Team Description"
} |
|
...
| Expand |
|---|
|
Add member to team. Path |
Add member to team
Add member to team.
Permissions:
| Code Block |
|---|
POST {jira_baseurl}/rest/vacation-manager/1.0/team/{teamId}/memberPermissions |
Responses:
...
...
...
...
...
...
...
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 |
...
MemberRole
...
USER
...
Enum
...
User role for member
...
SUPERVISOR
...
Responses
...
...
Example
...
MemberRole
Name | Type | Description |
|---|
USER | Enum | User role for member |
SUPERVISOR | Enum | Supervisor role for member |
| Expand |
|---|
|
Path| Code Block |
|---|
POST {jira_baseurl}/rest/vacation-manager/1.0/team/1/member |
Add user to teamBody |
...
|
|---|
{
"type":"USER",
"name":"user 1",
"role":"USER"
} |
Response |
...
...
{
"id": 1,
"userId": 10000,
"role": "USER",
"teamId": 1
} |
Add group to teamBody |
...
...
{
"type":"GROUP",
"name":"users",
"role":"USER"
} |
|
...
...
...
| Code Block |
|---|
{
"id": 6,
"groupName": "users",
"role": "USER",
"teamId": 1
} |
|
...
PATCH
...
Update existing team.
Path
Update team
Update existing team.
Permissions:
| Code Block |
|---|
PATCH {jira_baseurl}/rest/vacation-manager/1.0/team/{teamId}Permissions |
Responses:
...
...
...
...
...
...
...
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 |
...
...
Example
...
...
...
(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. |
| Expand |
|---|
|
Path| Code Block |
|---|
PATCH {jira_baseurl}/rest/vacation-manager/1.0/team/1 |
Body |
...
...
{
"name": "new team name"
} |
Request |
...
{
"id": 1,
"name": "new team name",
"description": "Team Description |
|
...
",
"allowUsersViewStatistics":false,
"defaultSupervisorId": 10101
} |
|
...
DELETE
...
Delete existing team.
...
Delete team
Delete existing team.
Permissions:
| Code Block |
|---|
DELETE {jira_baseurl}/rest/vacation-manager/1.0/team/{teamId}Permissions |
Responses:
...
...
...
...
Path params
...
...
...
Responses
...
...
Example
...
| Type | Description |
|---|
teamId | int | Team ID |
| Expand |
|---|
|
Request| Code Block |
|---|
DELETE {jira_baseurl}/rest/vacation-manager/1.0/team/1 |
|
...
| Expand |
|---|
| title | Remove member from team |
|---|
|
Remove member from team. Path |
Remove member from team
Remove member from team.
Permissions:
| Code Block |
|---|
DELETE {jira_baseurl}/rest/vacation-manager/1.0/team/{teamId}/memberPermissions |
Responses:
...
...
...
...
...
...
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 |
Responses
| Status |
|---|
| colour | Green |
|---|
| Expand |
|---|
| 204 |
Example| Code Block |
|---|
| title | PathPath
| Code Block |
|---|
DELETE {jira_baseurl}/rest/vacation-manager/1.0/team/1/member |
Body
| Code Block |
|---|
title | Body |
|---|
{
"type":"GROUP",
"name":"users",
"role":"USER"
} |
|---|