Overview

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

Methods:

GET

Overview

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

Methods:

GET

Anchor

	getTeams
	getTeams

Expand

title	Get teams list

Get list of all teams.

Path

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

Permissions

Status

colour	Green
title	ADMIN

Status
colour Red
title USER

Status
colour Red
title SUPERVISOR

Status
colour Green
title HR

Responses

Status

colour	Green
title	200

Status

colour	Red
title	500

Example

Expand

title

Path

Example

Code Block

title	Path

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

Code Block

title	Request

code

[
    {
        "id": 1,
        "name": "team 1",
        "description": "description 1"
    },
    {
        "id": 2,
        "name": "team 2",
        "description": "description 2"
    },
    {
        "id": 3,
        "name": "team 3",
        "description": "description 3"
    }
]

Anchor

	getTeam
	getTeam

Example

Path

Expand

title	Get single team

Get information about existing team members.

Path

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

Permissions

Status

colour	Green
title	ADMIN

Status
colour Red
title USER

Status
colour Red
title SUPERVISOR

Status
colour Green
title HR

Path params

Name	Type	Description
teamId	int	Team ID

Responses

Status

colour	Green
title	200

Status

colour	Yellow
title	404

Status

colour

Red

title

500

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

Response

Code Block{

	Red
title	500

Example

Expand

title	Example

Code Block

title	Path

GET {jira_baseurl}/rest/vacation-manager/1.0/team/1

Code Block

title	Response

{
  "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
    }
  ]
}

Anchor

	getTeamMember
	getTeamMember

...

Expand

title	Get team members

Get information about existing team.

Path

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

Permissions

Status
colour Green
title ADMIN

Status
colour Green
title USER

Status
colour Red
title SUPERVISOR

Status
colour Green
title HR

Path params

Name	Type	Description
teamId	int	Team ID

Responses

Status

colour	Green
title	200

Status

colour	Yellow
title	400

Status

colour	Red
title	500

Example

Expand

title	Example

Code Block

title	Path

GET {jira_baseurl}/rest/vacation-manager/1.0/team/1/member

Code Block

title	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":

1

5,

"name

              "userId":

"teamName",

50,

"description

           "role": "

description

SUPERVISOR",

"users":

[

{

id

teamId": 1
			},
			{

"name": "user 1",

displayName

id":

"User 1",

6,

"active":

true

},

  "userId": 60,

{

"id":

2,

name

role": "

user 2

SUPERVISOR",

"displayName":

"User

2",

active

teamId":

true

}

			}
		],

{

id

groups":

3,

 [
			{

"name":

"user

3",

displayName

id":

"User 3"

8,

"active":

true

}

],

  "groupName": "supervisors"

:

[

{

id

role":

4

"SUPERVISOR",

"name": "supervisor 1",

displayName

teamId":

"Supervisor 1",

"active": true

}
		]
    }

]

...

POST

Anchor
createTeam
createTeam

Expand

title	Create team

Creates new team.

Path

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

Permissions

Status

colour	Green
title	ADMIN

Status
colour Red
title USER

Status
colour Red
title SUPERVISOR

Status
colour Green
title HR

JSON body fields

Name	Type	Description
name	String	Team name, must be unique for each team
description	String (Optional)	Team description

Responses

Status

colour	Green
title	201

Status

colour	Yellow
title	400

Status

colour	Red
title	500

Example

Expand

Path

title	Example

Code Block

title	Path

POST {jira_baseurl}/rest/vacation-manager/1.0/team

Code Block

title	Body

code

{
    "name": "Team name",
    "description": "Team Description"
}

Code Block

title	Response

code

{
	"id": 
    "name": "Team name",
    "description": "Team Description"
}

Anchor

	addMember
	addMember

Expand

title	Add member to team

Add member to team.

Path

Code Block
POST {jira_baseurl}/rest/vacation-manager/1.0/team/{teamId}/member

Permissions

Status

colour	Green
title	ADMIN

Status
colour Red
title USER

Status
colour Red
title SUPERVISOR

Status
colour Green
title HR

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

Responses

Status

colour	Green
title	201

Status

colour	Yellow
title	400

Status


colour	Yellow
title	404

Status

colour	Red
title	500

Example

Expand

title

Path

Example

Code Block

title	Path

POST {jira_baseurl}/rest/vacation-manager/1.0/team/1/member

Add user to team

Code Block

title	Body

code

{
	"type":"USER",
	"name":"user 1",
	"role":"USER"
}

Code Block

title	Response

code

{
    "id": 1,
    "userId": 10000,
    "role": "USER",
    "teamId": 1
}

Add group to

team

Code Block

title	Body

code

{
	"type":"GROUP",
	"name":"users",
	"role":"USER"
}

Code Block

title	Response

Code Block

{
    "id": 6,
    "groupName": "users",
    "role": "USER",
    "teamId": 1
}

PATCH

Anchor

	updateTeam
	updateTeam

Expand

title	Update team

Update existing team.

Path

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

Permissions

Status

colour	Green
title	ADMIN

Status
colour Red
title USER

Status
colour Red
title SUPERVISOR

Status
colour Green
title HR

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

Responses

Status


colour	Green
title	200

Status

colour	Yellow
title	400

Status


colour	Yellow
title	404

Status

colour	Red
title	500

Example

Expand

Path

title	Example

Code Block

title	Path

PATCH {jira_baseurl}/rest/vacation-manager/1.0/team/1

Code Block

title	Body

code

{
    "name": "new team name"
}

Code Block

title	Request

code

{
    "id": 1,
    "name": "new team name",
    "description": "Team Description"
}

DELETE

Anchor

	deleteTeam
	deleteTeam

Expand

title	Delete team

Delete existing team.

Path

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

Permissions

Status

colour	Green
title	ADMIN

Status
colour Red
title USER

Status
colour Red
title SUPERVISOR

Status
colour Green
title HR

Path params

Name	Type	Description
teamId	int	Team ID

Responses

Status


colour	Green
title	204

Status

colour	Yellow
title	404

Status

colour	Red
title	500

Example

Expand

title

Request

Example

Code Block

title	Request

DELETE {jira_baseurl}/rest/vacation-manager/1.0/team/1

Anchor

	removeTeamMember
	removeTeamMember

Expand

title	Remove member from team

Remove member from team.

Path

Code Block
DELETE {jira_baseurl}/rest/vacation-manager/1.0/team/{teamId}/member

Permissions

Status

colour	Green
title	ADMIN

Status
colour Red
title USER

Status
colour Red
title SUPERVISOR

Status
colour Green
title HR

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


colour	Green
title	204

Status

colour	Yellow
title	404

Status

colour	Red
title	500

Example

Path

Expand

title	Example

Code Block

title	Path

DELETE {jira_baseurl}/rest/vacation-manager/1.0/team/1/member

Code Block

title	Body

code

{
	"type":"GROUP",
	"name":"users",
	"role":"USER"
}

Page Comparison

Versions Compared

Old Version 8

New Version 9

Key

Methods:

GET

Methods:

GET

Path

Permissions

Responses

Example

Path

Permissions

Path params

Responses

Path

Response

Path

Permissions

StatuscolourGreentitleADMIN StatuscolourGreentitleUSER StatuscolourRedtitleSUPERVISOR StatuscolourGreentitleHRPath params

Responses

Example

POST

AnchorcreateTeamcreateTeam

Path

Permissions

JSON body fields

Responses

Example

Path

Permissions

Path params

MemberType

MemberRole

Responses

Example

Add user to team

Add group to

team

PATCH

Path

Permissions

Path params

Responses

Example

DELETE

Path

Permissions

Path params

Responses

Example

Path

Permissions

Path params

JSON body fields

Responses

Example

Status
colour Green
title ADMIN

Status
colour Green
title USER

Status
colour Red
title SUPERVISOR

Status
colour Green
title HR

Path params

Anchor
createTeam
createTeam