Versions Compared

Old Version 3

changes.mady.by.user Marcin Wikarski

Saved on

compared with

New Version Current

changes.mady.by.user Damian Karbownik

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Vacation Manager's REST API provides team API which allows you to obtain:

Methods:

GET

...

Table of Contents
minLevel1
maxLevel2

GET

Get teams list

Get list of all teams

...

Path

...

.

...

Permissions:

Status
colourGreen
titleADMIN
 
Status
colourRed
titleUSER
 
Status
colourRed
titleSUPERVISOR
 
Status
colour

...

Green
titleHR

Code Block
GET {jira_baseurl}/rest/vacation-manager/1.0/team

Responses:

Status
colourGreen
title200
 
Status
colourRed
title500

...

Expand
titleExample

Path

GET {jira_baseurl}/rest/vacation-manager/1.0/team
Code Block
titlePath
Request

...

Expand
titleGet single team

Get information about existing team members.

Path

Code Block
GET {jira_baseurl}/rest/vacation-manager/1.0/team/{teamId}
Permissionstitle
[
    {
        "id": 1,
        "name": "team 1",
        "description": "description 1"
    },
    {
        "id": 2,
        "name": "team 2",
        "description": "description 2"
    },
    {
        "id": 3,
        "name": "team 3",
        "description": "description 3"
    }
]
Code Block
Request

...

Get single team

Get information about existing team members.

Permissions:

Status
colourGreen
titleADMIN
 
Status
colourRed
titleUSER
 
Status
colourRed
titleSUPERVISOR
 
Status
colourGreen
titleHR

Path paramsResponses
Name
Type
Description
teamIdintTeam ID
Code Block
GET {jira_baseurl}/rest/vacation-manager/1.0/team/{teamId}

Responses:

Status
colourGreen
title200
 
Status
colourYellow
title404
 
Status
colourRed
title500

...

Path params

Name

Type

Description

teamId

int

Team ID

Expand
titleExample

...

title
Expand
Path
Path
Code Block
title
GET {jira_baseurl}/rest/vacation-manager/1.0/team/1

Response

title
{
  "id": 1,
  "name": "teamName",
  "description": "description",
  "users": [
    {
      "id": 1,
      "name": "user 1",
      "displayName": "User 1",
      "active": true
    },
    {
      "id": 2,
      "name": "user 2",
      "displayName": "User 2",
      "active": true
    },
    {
      "id": 3,
      "name": "user 3",
      "displayName": "User 3",
      "active": true
    }
  ],
  "supervisors": [
    {
      "id": 4,
      "name": "supervisor 1",
      "displayName": "Supervisor 1",
      "active": true
    }
  ]
}
Code Block
Response

...

Get team members
Get information about existing 
...
Path
 Code Block
GET {jira_baseurl}/rest/vacation-manager/1.0/team/{teamId}/member
...
team.
Permissions: 
 Status
colourGreen
titleADMIN
 
 Status
colourGreen
titleUSER
 
 Status
colourRed
titleSUPERVISOR
 
 Status
colourGreen
titleHR
Path paramsResponses
Name
Type
Description
teamIdintTeam ID
 Code Block
GET {jira_baseurl}/rest/vacation-manager/1.0/team/{teamId}/member
Responses: 
 Status
colourGreen
title200
 
 Status
colourYellow
title400
...
 Status
colourRed
title500
...
 
 Status
colourRed
title500
Path params
Name
Type
Description
teamId
int
Team ID
 Expand
titleExample
Path
Path
 Code Block
title
GET {jira_baseurl}/rest/vacation-manager/1.0/team/1/member
Response
{
    "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
			},
			{
                "id": 6,
                "userId": 60,
                "role": "SUPERVISOR",
                "teamId": 1
			}
		],
        "groups": [
			{
                "id": 8,
                "groupName": "supervisors",
                "role": "SUPERVISOR",
                "teamId": 1
            }
		]
    }
}

 Code Block
titleResponse
POST 
...
titleCreate team
Creates new team.
Path
 Code Block
POST {jira_baseurl}/rest/vacation-manager/1.0/team
...
POST
Create team
Creates new team.
Permissions: 
 Status
colourGreen
titleADMIN
 
 Status
colourRed
titleUSER
 
 Status
colourRed
titleSUPERVISOR
 
 Status
colourGreen
titleHR
JSON body fields
Responses
NameTypeDescription
name
String
Team name, must be unique for each team
description
String (Optional)
Team description
 Code Block
POST {jira_baseurl}/rest/vacation-manager/1.0/team
Responses: 
 Status
colourGreen
title201
 
 Status
colourYellow
title400
 
 Status
colourRed
title500
...
JSON body fields
Name
Type
Description
name
String
Team name, must be unique for each team
description
String (Optional)
Team description
 Expand
titleExample
...
title
 Expand
Path
Path
 Code Block
title
POST {jira_baseurl}/rest/vacation-manager/1.0/team
Body
Body
 Code Block
title
{
    "name": "Team name",
    "description": "Team Description"
}
Response
Response
 Code Block
title
{
	"id": 
    "name": "Team name",
    "description": "Team Description"
}
...
Add member to team
Add member to team.
...
Permissions: 
 Status
colourGreen
titleADMIN
 
 Status
colourRed
titleUSER
 
 Status
colourRed
titleSUPERVISOR
 
 Status
colourGreen
titleHR
 Code Block
POST {jira_baseurl}/rest/vacation-manager/1.0/team/{teamId}/member
Permissions
Responses: 
 Status
colourGreen
title
...
201
 
 Status
colour
...
Yellow
title
...
400
 
 Status
colour
...
Yellow
title
...
404
 
 Status
colour
...
Red
title
...
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 
...
MemberType
...
USER
...
User type
...
GROUP
...
MemberRole
...
USER
...
Enum
...
 for member
...
SUPERVISOR
...
Responses
 Status
colourGreen
title201
...
 Status
colourYellow
title400
...
 Status
colourRed
title500
...
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
 Expand
titleExample
Path
 Code Block
...
POST {jira_baseurl}/rest/vacation-manager/1.0/team/1/member
Add user to team
Body
 Code Block
...
...
{
	"type":"USER",
	"name":"user 1",
	"role":"USER"
}
...
...
Response
...
 Code Block
{
    "id": 1,
    "userId": 10000,
    "role": "USER",
    "teamId": 1
}
Add group to team
Body
 Code Block
...
{
	"type":"GROUP",
	"name":"users",
	"role":"USER"
}
Response
 Code Block
...
...
{
    "id": 6,
    "groupName": "users",
    "role": "USER",
    "teamId": 1
}
...
PATCH
...
titleUpdate team
Update existing team.
Path
Update team
Update existing team.
Permissions: 
 Status
colourGreen
titleADMIN
 
 Status
colourRed
titleUSER
 
 Status
colourRed
titleSUPERVISOR
 
 Status
colourGreen
titleHR
 Code Block
PATCH {jira_baseurl}/rest/vacation-manager/1.0/team/{teamId}
Permissions
Responses: 
 Status
colourGreen
title
...
200
 
 Status
colour
...
Yellow
title
...
400
 
 Status
colour
...
Yellow
title
...
404
 
 Status
colour
...
Red
title
...
500
Path params
Name
Type
Description
teamId
int
Team ID

JSON body fields
Example
...
titleExample
...
Name
Type
Description
name
String
Team name, must be unique
description
String (Optional)
Team description
Responses
...
 Status
colourYellow
title400
...
 Status
colourRed
title500
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.
 Expand
titleExample
Path
 Code Block
PATCH {jira_baseurl}/rest/vacation-manager/1.0/team/1
Body
 Code Block
...
titleBody
...
{
    "name": "new team name"
}
Request
 Code Block
{
    "id": 1,
    "name": "new team name"
...
titleRequest
...
,
    "
...
description": "Team 
...
Description",
    "
...
allowUsersViewStatistics":
...
false,
    "
...
defaultSupervisorId":
...
DELETE
...
titleDelete team
Delete existing team.
...
 10101
}
...
DELETE
Delete team
Delete existing team.
Permissions: 
 Status
colourGreen
titleADMIN
 
 Status
colourRed
titleUSER
 
 Status
colourRed
titleSUPERVISOR
 
 Status
colourGreen
titleHR
 Code Block
DELETE {jira_baseurl}/rest/vacation-manager/1.0/team/{teamId}
Permissions
Responses: 
 Status
colourGreen
title
...
204
 
 Status
colour
...
Yellow
title
...
404
 
 Status
colourRed
...
title
...
500
Path params
Name
Type
Description
teamId
int
Team ID
Responses 
 Expand
title
Example
status
Request
colourGreen
title204
 Code Block
DELETE {jira_baseurl}/rest/vacation-manager/1.0/team/1
Remove member from team
Remove member from team.
Permissions: 
 Status
colour
...
Green
title
...
ADMIN
 
 Status
colourRed
title
...
USER
...
 
...
 Status
...
colour
...
Red
title
...
DELETE {jira_baseurl}/rest/vacation-manager/1.0/team/1
...
titleRemove member from team
Remove member from team.
...
SUPERVISOR
 
 Status
colourGreen
titleHR
 Code Block
DELETE {jira_baseurl}/rest/vacation-manager/1.0/team/{teamId}/member
Permissions
 Status
colourGreen
titleADMIN
 
Responses: 
 Status
colour
...
Green
title
...
204
 
 Status
colour
...
Yellow
title
...
404
 
 Status
colour
...
Red
title
...
500
Path params
Name
Type
Description
teamId
int
Team ID
JSON body fields
Name
Type
Description
type
String
Type of member to remove
  • USER
  • GROUP
name
String
Name of the member you want to remove from the team
role
String
Role for member to remove
  • USER
  • SUPERVISOR
Responses
 
 Status
colourGreen
title204
 Status
colourYellow
title404
 
 Status
colourRed
title500
Example
 Expand
titleExample
 Code Block
titlePath
 Expand
titleExample
Path
 Code Block
DELETE {jira_baseurl}/rest/vacation-manager/1.0/team/1/member
Body
Body
 Code Block
title
{
	"type":"GROUP",
	"name":"users",
	"role":"USER"
}