Overview

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

Methods:

GET

...

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
GET {jira_baseurl}/rest/vacation-manager/1.0/team

Request

...

Table of Contents

minLevel	1
maxLevel	2

GET

Get teams list

Get list of all teams.

Permissions:

Status

colour	Green
title	ADMIN

Status

colour	Red
title	USER

Status

colour	Red
title	SUPERVISOR

Status

colour	Green
title	HR

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

Responses:

Status

colour	Green
title	200

Status

colour	Red
title	500

Expand

title	Example

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:

Status

colour	Green
title	ADMIN

Status

colour	Red
title	USER

Status

colour	Red
title	SUPERVISOR

Status

colour	Green
title	HR

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

Responses:

Status

colour	Green
title	200

Status

colour	Yellow
title	404

Status

colour	Red
title	500

Path params

Name	Type	Description
teamId	int	Team ID

Expand

title	Example

Path

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

Response

Code Block

{
  "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",
        "descriptionactive": true
"description 3"   }
 } ]

...

title

Expand

Get

...

team members

Get information about existing team

...

.

Path

Permissions:

Status

colour	Green
title	ADMIN

Status

colour	Green
title	USER

Status

colour	Red
title	SUPERVISOR

Status

colour	Green
title	HR

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

Responses:

Status

title
colour	Green

...

200

Status

colour

...

title
Yellow

...

400

Status

title
colour	Red

...

Status

colour	Green
title	HR

500

Path params

Name	Type	Description
teamId	int	Team ID

Responses

Green200

Status

colour

Expand

title

Example

Path

Status

colour	Yellow
title	404

Status

colour	Red
title	500

Example

Path

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

Response

{ "id": 1, "name": "teamName", "description": "description", "users": [ {

Code Block
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",
                "id": 1,teamId": 1
			},
			{
                "nameid": "user 1",6,
       "displayName": "User 1",       "activeuserId": true60,
    },     {       "idrole": 2"SUPERVISOR",
       "name": "user 2",       "displayName": "User 2",teamId": 1
			}
		],
        "activegroups": true[
			{
    },     {       "id": 38,
      "name": "user 3",          "displayNamegroupName": "User 3supervisors",

     "active": true     }   ],   "supervisorsrole": [
  "SUPERVISOR",
  {       "id": 4,       "nameteamId": "supervisor 1",1
         "displayName": "Supervisor 1", }
		]
    "active": true
    }
  ]
}

...

POST

...

Expand

title	Create team

Creates new team.

Path

}
}

...

POST

Create team

Creates new team.

Permissions:

Status

colour	Green
title	ADMIN

Status

colour	Red
title	USER

Status

colour	Red
title	SUPERVISOR

Status

colour	Green
title	HR

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

Responses:

Status

title
colour	Green

...

201

Status

colour

...

title
Yellow

...

400

Status

title
colour	Red

...

Status

colour	Green
title	HR

500

JSON body fields

Name	Type	Description
name	String	Team name, must be unique

...

description

...

String (Optional)

...

Team description

Responses

Status

colour	Green
title	201

Status

colour	Yellow
title	400

Status

colour	Red
title	500

for each team
description	String (Optional)	Team description

Expand

title	Example

Path

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

Body

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

Response

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

...

Expand

title	Add member to team

Add member to team.

Path

": "Team Description"
}

Add member to team

Add member to team.

Permissions:

Status

colour	Green
title	ADMIN

Status

colour	Red
title	USER

Status

colour	Red
title	SUPERVISOR

Status

colour	Green
title	HR

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

Responses:

Status

title
colour	Green

...

201

Status

colour

...

title
Yellow

...

400

Status

colour

...

title
Yellow

...

404

Status

colour

...

title
Red

...

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

Responses

Status

colour	Green
title	201

...

Status

colour	Yellow
title	400

...

Status

colour	Yellow
title	404

...

	User type
GROUP	Enum	Group type

MemberRole

Name	Type	Description
USER	Enum	User role for member
SUPERVISOR	Enum	Supervisor role for member

Expand

title	Example

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"

...

PATCH

...

title	Update team

Update existing team.

...

: 1
}

...

PATCH

Update team

Update existing team.

Permissions:

Status

colour	Green
title	ADMIN

Status

colour	Red
title	USER

Status

colour	Red
title	SUPERVISOR

Status

colour	Green
title	HR

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

Responses:

Status

title
colour	Green

...

200

Status

colour

...

title
Yellow

...

400

Status

colour

...

title
Yellow

...

404

Status

colour

...

title
Red

...

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

...

colour	Green
title	200

...

Status

colour	Yellow
title	400

...

Status

colour	Yellow
title	404

...

(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

title	Example

Path

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

Body

Code Block
{ "name": "new team name" }

Request

Code Block
{ "id": 1, "name": "new team name", "description":

...

DELETE

...

title	Delete team

Delete existing team.

...

 "Team Description",
    "allowUsersViewStatistics":false,
    "defaultSupervisorId": 10101
}

...

DELETE

Delete team

Delete existing team.

Permissions:

Status

colour	Green
title	ADMIN

Status

colour	Red
title	USER

Status

colour	Red
title	SUPERVISOR

Status

colour	Green
title	HR

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

Responses:

Status

colour	Green

...

title

...

204

Status

colour

...

title
Yellow

...

404

Status

colour

...

title
Red

...

500

Path params

Name	Type	Description
teamId	int	Team ID

Responses

Expand

title	Example

Request

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

Remove member from team

Remove member from team.

Permissions:

Status

title
colour	Green

...

ADMIN

Status

colour

...

title
Red

...

USER

Status

title
colour	Red

...

SUPERVISOR

...

title	Remove member from team

Remove member from team.

...

Status

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

...

colour	Green
title	HR

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

Responses:

Status

title
colour	Green

...

204

Status

colour

...

title
Yellow

...

404

Status

title
colour	Red

...

Status

colour	Green
title	HR

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

colour	Green
title	204

Status

colour	Yellow
title	404

StatuscolourRedtitle500 Expand

title	Example

Path

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

Body

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

Page Comparison

Versions Compared

Old Version 6

New Version Current

Key

Methods:

GET

Path

Permissions

Responses

Example

Path

Request

GET

Get teams list

Request

Get single team

Path params

Path

Get

team members

Path

Path params

Responses

Path

Path

Response

Response

POST

POST

Create team

JSON body fields

Responses

Path

Add member to team

Path params

JSON body fields

MemberType

MemberRole

Responses

MemberRole

Path

Add user to team

Body

Response

Add group to team

Body

Response

PATCH

PATCH

Update team

Path params

JSON body fields

Path

Body

Request

DELETE

DELETE

Delete team

Path params

Request

Remove member from team

Path params

JSON body fields

Responses

Path

Body