Overview

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

create new team
add member to team
update team
delete team
remove member from team
get teams list
get single team
get team members

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

Path

Code Block

title	Path

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

Request

Code Block

title	Request

[
    {
        "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

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

Example

Path

Code Block

title


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

Response

Code Block

titleResponse

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

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

Path

Code Block
title

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

Body

Code Block
title

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

Response

Code Block

title	Response

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

...

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

Path

Code Block
title

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

Add user to team

Body

Code Block

title	Body

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

Response

Code Block

title	Response

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

Add group to team

Body

Code Block

title	Body

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

Response

Code Block
title

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

Path

Code Block

title	Path

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

Body

Code Block

title	Body

{
    "name": "new team name"
}

Request

Code Block
title

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

Request

Code Block
title

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

...

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

Code Block
title

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

Body

Code Block
title

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

...

Page Comparison

Versions Compared

Old Version 4

New Version 5

Key

Methods:

GET

Path

Permissions

Responses

Example

Path

Request

Path

Permissions

Path params

Responses

Path

Response

POST

AnchorcreateTeamcreateTeam

Path

Permissions

JSON body fields

Responses

Example

Path

Body

Response

Path

Permissions

Path params

MemberType

MemberRole

Responses

Example

Path

Add user to team

Body

Response

Add group to team

Body

Response

PATCH

Path

Permissions

Path params

Responses

Example

Path

Body

Request

DELETE

Path

Permissions

Path params

Responses

Example

Request

Path

Permissions

Path params

JSON body fields

Responses

Example

Path

Body

Anchor
createTeam
createTeam