1 GET
- 1.1 Get holiday schemes list
- 1.2 Get holiday scheme for user
2 POST
- 2.1 Create holiday scheme
3 PATCH
- 3.1 Update holiday scheme
4 PUT
- 4.1 Assign holiday scheme to users
5 DELETE
- 5.1 Delete holiday scheme

GET

Get holiday schemes list

Returns list of holiday schemes.

Permissions: ADMIN USER SUPERVISOR HR

GET {jira_baseurl}/rest/vacation-manager/1.0/holiday-scheme

Responses: 200 500

Path

GET {jira_baseurl}/rest/vacation-manager/1.0/holiday-scheme

Response

[
  {
    "id": 1,
    "name": "Default holiday scheme"
  },
  {
    "id": 2,
    "name": "Holiday scheme 1"
  },
  {
    "id": 3,
    "name": "Holiday scheme 2"
  }
]

Get holiday scheme for user

Returns holiday scheme used by given user.

Permissions: ADMIN USER SUPERVISOR HR

GET {jira_baseurl}/rest/vacation-manager/1.0/holiday-scheme/user/{userName}

Responses: 200 500

Query params

Name	Type	Description

Name	Type	Description
userName	string	User name

Path

GET {{baseurl}}/rest/vacation-manager/1.0/holiday-scheme/user/admin

Response

{
    "id": 1,
    "name": "Default holiday scheme"
}

POST

Create holiday scheme

Creates and return new holiday scheme.

Permissions: ADMIN USER SUPERVISOR HR

POST {jira_baseurl}/rest/vacation-manager/1.0/holiday-scheme

Responses: 201 400 500

JSON body fields

Name	Type	Description

Name	Type	Description
name	String	Holiday scheme name, must be unique for each scheme

Path

POST {jira_baseurl}/rest/vacation-manager/1.0/holiday-scheme

Body

  {
    "name": "Holiday scheme name"
  }

Response

  {
	"id": 2
    "name": "Holiday scheme name"
  }

PATCH

Update holiday scheme

Updates and return existing holiday scheme.

Permissions: ADMIN USER SUPERVISOR HR

PATCH {jira_baseurl}/rest/vacation-manager/1.0/holiday-scheme/{schemeId}

Responses: 200 400 404 500

Path params

Name	Type	Description

Name	Type	Description
schemeId	int	Holiday scheme ID

JSON body fields

Name	Type	Description

Name	Type	Description
name	String	Holiday scheme new name

Path

PATCH {jira_baseurl}/rest/vacation-manager/1.0/holiday-scheme/2

Body

{
   "name": "Holiday scheme name"
}

Response

{
   "id": 2,
   "name": "Holiday scheme name"
}

PUT

Assign holiday scheme to users

Assigns holiday scheme to users.

Permissions: ADMIN USER SUPERVISOR HR

PUT {jira_baseurl}/rest/vacation-manager/1.0/vacman-user/holidays/bulk

Responses: 200 400 404 500

JSON body fields

Name	Type	Description

Name	Type	Description
schemeId	`Integer`	Id of holiday scheme you want to assign to users
userNames	`Array<String>`	Names of users you want to assign holiday scheme to

Path

PUT {jira_baseurl}/rest/vacation-manager/1.0/vacman-user/holidays/bulk

Body

{
   "schemeId": 1,
   "userNames": ["john", "jack"]
}

Response

{  
	"userNames": [
		"john", 
		"jack"
	],
   "schemeId": 1
}

DELETE

Delete holiday scheme

Deletes existing holiday scheme.

Permissions: ADMIN USER SUPERVISOR HR

DELETE {jira_baseurl}/rest/vacation-manager/1.0/holiday-scheme/{schemeId}

Responses: 204 404 500

Path params

Name	Type	Description

Name	Type	Description
schemeId	`Integer`	Id of holiday scheme you want to assign to users

Path

DELETE {jira_baseurl}/rest/vacation-manager/1.0/holiday-scheme/1

Vacation Manager for JIRA

[REST 1.1] Holiday schemes

Analytics

GET

Get holiday schemes list

Path

Response

Get holiday scheme for user

Query params

POST

Create holiday scheme

JSON body fields

Path

Body

PATCH

Update holiday scheme

Path params

JSON body fields

Path

Response

PUT

Assign holiday scheme to users

JSON body fields

Path

Body

Response

DELETE

Delete holiday scheme

Path params

Path

Related content