Overview

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

create workweek scheme
update workweek scheme
assign workweek scheme to users
delete Workweek Scheme
get workweek schemes list
get single workweek scheme
get workweek scheme for user

Methods:

GET

...

Table of Contents

minLevel	1
maxLevel	2

GET

Get workweek schemes list

Returns list of workweek schemes

...

Path

...

.

...

Permissions:

Status

colour	Green
title	ADMIN

Status

colour	Red
title	USER

Status

colour	Red
title	SUPERVISOR

Status

colour	Green
title	HR

Status

colour	Green
title	HR

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

Responses:

Status

colour	Green
title	200

Status

colour	Yellow
title	400

Status

colour	Red
title	500

Example

Expand

title	Example

...

title

Expand

Code Block

title	Path

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

Code Block

title	Response

[
  {
    "id": 1,
    "name": "Default workweek scheme",
    "workweekMinutes": {
      "TUESDAY": 480,
      "SUNDAY": 0,
      "MONDAY": 480,
      "WEDNESDAY": 480,
      "FRIDAY": 480,
      "THURSDAY": 480,
      "SATURDAY": 0
    },
    "type": "SEPARATE_WORK_MINUTES_FOR_EACH_DAY"
  },
  {
    "id": 2,
    "name": "Workweek scheme 2",
    "workweekMinutes": {
      "TUESDAY": 480,
      "SUNDAY": 0,
      "MONDAY": 480,
      "WEDNESDAY": 480,
      "FRIDAY": 480,
      "THURSDAY": 480,
      "SATURDAY": 0
    },
    "type": "SAME_WORK_MINUTES_FOR_ALL_DAYS"
  },
  {
    "id": 3,
    "name": "Workweek scheme 3",
    "workweekMinutes": {
      "TUESDAY": 480,
      "SUNDAY": 0,
      "MONDAY": 480,
      "WEDNESDAY": 400,
      "FRIDAY": 480,
      "THURSDAY": 400,
      "SATURDAY": 0
    },
    "type": "SEPARATE_WORK_MINUTES_FOR_EACH_DAY"
  }
]

...

Get single

...

Returns information about existing workweek scheme.

Path

Code Block
GET {jira_baseurl}/rest/vacation-manager/1.0/workweek-scheme/{schemeId}

...

workweek scheme

Returns information about existing workweek scheme.

Permissions:

Status

colour	Green
title	ADMIN

Status

colour	Red
title	USER

Status

colour	Red
title	SUPERVISOR

Status

colour	Green
title	HR

Path paramResponses

Name	Type	Description
schemeId	int	Scheme ID
Code Block
GET {jira_baseurl}/rest/vacation-manager/1.0/workweek-scheme/{schemeId}

Responses:

Status

colour	Green
title	200

Status

colour	Yellow
title	400

Status

colour	Red
title	500

...

Path param

Name	Type	Description
schemeId	int	Scheme ID

Expand

title	Example

...

expand

Code Block

title	Path

GET {jira_baseurl}/rest/vacation-manager/1.0/workweek-scheme/1

Code Block

title	Response

{
  "id": 1,
  "name": "Default workweek scheme",
  "workweekMinutes": {
    "TUESDAY": 480,
    "SUNDAY": 0,
    "MONDAY": 480,
    "WEDNESDAY": 480,
    "FRIDAY": 480,
    "THURSDAY": 480,
    "SATURDAY": 0
  },
  "type": "SEPARATE_WORK_MINUTES_FOR_EACH_DAY"
}

...

title

Get workweek scheme for

...

Returns workweek scheme used by given user.

Path

Code Block
GET {jira_baseurl}/rest/vacation-manager/1.0/workweek-scheme?userName={userName}

...

user

Returns workweek scheme used by given user.

Permissions:

Status

colour	Green
title	ADMIN

Status

colour	Red
title	USER

Status

colour	Red
title	SUPERVISOR

Status

colour	Green
title	HR

Query params

Responses

Name	Type	Description
userName	String	User Name
Code Block
GET {jira_baseurl}/rest/vacation-manager/1.0/workweek-scheme?userName={userName}

Responses:

Status

colour	Green
title	200

Status

colour	Yellow
title	400

Status

colour	Red
title	500

...

Query params

Name	Type	Description
userName	String	User Name

Expand

title	Example

Code Block

title	Path

PATH{jira_baseurl}/rest/vacation-manager/1.0/workweek-scheme?userName=user1

...

Expand

title	Create new workweek scheme

Creates and returns new workweek scheme.

Path

Code Block

title	Response

{
  "id": 1,
  "name": "Default workweek scheme",
  "workweekMinutes": {
    "TUESDAY": 480,
    "SUNDAY": 0,
    "MONDAY": 480,
    "WEDNESDAY": 480,
    "FRIDAY": 480,
    "THURSDAY": 480,
    "SATURDAY": 0
  },
  "type": "SEPARATE_WORK_MINUTES_FOR_EACH_

DAY" }

POST

...

DAY"
}

...

POST

Create new workweek scheme

Creates and returns new workweek scheme.

Permissions:

Status

colour	Green
title	ADMIN

Status

colour	Red
title	USER

Status

colour	Red
title	SUPERVISOR

Status

colour	Green
title	HR

Request /workweek-scheme

Code Block

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

Permissions

Status

colour	Green
title	ADMIN

Responses:

Status

colour

...

title
Green

...

201

Status

colour

...

title
Yellow

...

400

Status

colour

...

title
Red

...

500

JSON body fields

Name	Type	Description
name	String	Workweek scheme name
workweekMinutes	Map<DayOfWeek, Integer>	Day of week : working time in minutes
type	WorkweekSchemeType	Type of work week scheme

DayOfWeek

Name	Type	Description
MONDAY	Enum	Monday
TUESDAY	Enum	Tuesday
WEDNESDAY	Enum	Wednesday
THURSDAY	Enum	Thursday
FRIDAY	Enum	Friday
SATURDAY	Enum	Saturday
SUNDAY	Enum	Sunday

WorkweekSchemeType

Name	Type	Description
SAME_WORK_MINUTES_FOR_ALL_DAYS	Enum	Type of the same work minutes for all days
SEPARATE_WORK_MINUTES_FOR

...

Enum

...

Type of separate work minutes for each day

Responses

Status

colour	Green
title	201

Status

colour	Yellow
title	400

Status

colour	Red
title	500

...

_EACH_DAY

Enum

Type of separate work minutes for each day

Expand

title	Example

Code Block

title	Path

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

Code Block

title	Body

{
  "name": "Workweek scheme name",
  "workweekMinutes": {
    "FRIDAY": 480,
    "MONDAY": 400,
    "WEDNESDAY": 800,
    "SUNDAY": 0,
    "TUESDAY": 480,
    "SATURDAY": 0,
    "THURSDAY": 400
  },
  "type": "SEPARATE_WORK_MINUTES_FOR_EACH_DAY"
}

...

Expand

title	Update workweek scheme

Update and return existing workweek scheme.

Path

Code Block

title	Response

{
  "id": 101,
  "name": "Workweek scheme name",
  "workweekMinutes": {
    "TUESDAY": 480,
    "SUNDAY": 0,
    "MONDAY": 400,
    "WEDNESDAY": 800,
    "FRIDAY": 480,
    "THURSDAY": 400,
    "SATURDAY": 0
  },
  "type": "SEPARATE_WORK_MINUTES_FOR_EACH_

DAY" }

PATCH

...

DAY"
}

...

PATCH

Update workweek scheme

Update and return existing workweek scheme.

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/workweek-scheme/{schemeId} 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
schemeId	int	Scheme ID

JSON body fields

Name	Type	Description
name	String	Workweek scheme name
workweekMinutes	Map<DayOfWeek, Integer>	Day of week : working time in minutes
type	WorkweekSchemeType	Type of work week scheme

DayOfWeek

Name	Type	Description
MONDAY	Enum	Monday
TUESDAY	Enum	Tuesday
WEDNESDAY	Enum	Wednesday
THURSDAY	Enum	Thursday
FRIDAY	Enum	Friday
SATURDAY	Enum	Saturday
SUNDAY	Enum	Sunday

WorkweekSchemeType

Name	Type	Description
SAME_WORK_MINUTES_FOR_ALL_DAYS	Enum	Type of the same work minutes for all days
SEPARATE_WORK_MINUTES_FOR

...

Enum

...

Type of separate work minutes for each day

Responses

Status

colour	Green
title	200

Status

colour	Yellow
title	400

Status

colour	Yellow
title	404

Status

colour	Red
title	500

...

_EACH_DAY

Enum

Type of separate work minutes for each day

Expand

title	Example

Code Block

title	Path

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

Code Block

title	Body

 {
  "name": "Workweek scheme new name",
  "workweekMinutes": {
    "FRIDAY": 480,
    "MONDAY": 400,
    "WEDNESDAY": 800,
    "SUNDAY": 0,
    "TUESDAY": 480,
    "SATURDAY": 0,
    "THURSDAY": 400
  },
  "type": "SEPARATE_WORK_MINUTES_FOR_EACH_DAY"
}

...

Expand

title	Assign workweek scheme to users

Assigns workweek scheme to users.

Path

Code Block

title	Response

{
  "id": 2,
  "name": "Workweek scheme new name",
  "workweekMinutes": {
    "FRIDAY": 480,
    "MONDAY": 400,
    "WEDNESDAY": 800,
    "SUNDAY": 0,
    "TUESDAY": 480,
    "SATURDAY": 0,
    "THURSDAY": 400
  },
  "type": "SEPARATE_WORK_MINUTES_FOR_

EACH_DAY" }

PUT

...

EACH_DAY"
}

...

PUT

Assign workweek scheme to users

Assigns workweek scheme to users.

Permissions:

Status

colour	Green
title	ADMIN

Status

colour	Red
title	USER

Status

colour	Red
title	SUPERVISOR

Status

colour	Green
title	HR

Code Block
PUT {jira_baseurl}/rest/vacation-manager/1.0/vacman-user/workweek/bulk Permissions

Responses:

Status

title
colour	Green

...

200

Status

colour

...

title
Yellow

...

400

Status

colour

...

title
Yellow

...

404

Status

colour

...

title
Red

...

500

JSON body fields

Name

Type

Description

schemeId

Code Block
Integer

Id of workweek scheme you want to assign to users

userNames

Code Block
Array<String>

Names of users you want to assign workweek scheme

...

Responses

Status

colour	Green
title	200

Status

colour	Yellow
title	400

Status

colour	Yellow
title	404

Status

colour	Red
title	500

...

to

Expand

title	Example

Code Block

title	Path

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

Code Block

title	Body

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

Code Block

title	Response

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

...

DELETE

...

title	Delete workweek scheme

Deletes existing workweek scheme.

Path

Delete workweek scheme

Deletes existing workweek scheme.

Permissions:

Status

colour	Green
title	ADMIN

Status

colour	Red
title	USER

Status

colour	Red
title	SUPERVISOR

Status

colour	Green
title	HR

Scheme ID

Code Block

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

Permissions

ADMIN USER SUPERVISOR HR

Path params

Name

Type

Description

schemeId

int

Responses:

Status

colour	Green
title	204

Status

colour	Yellow
title	404

Status

colour	Red
title	500

...

Path params

Name	Type	Description
schemeId	int	Scheme ID

Expand

title	Example

Code Block

title	Path

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

Page Comparison

Versions Compared

Old Version 10

New Version 11

Key

Methods:

GET

GET

Get workweek schemes list

Path

Example

Get single

Path

workweek scheme

Path param

Get workweek scheme for

Path

user

Query params

Query params

POST

POST

Create new workweek scheme

Request /workweek-scheme

Permissions

JSON body fields

DayOfWeek

WorkweekSchemeType

Responses

PATCH

PATCH

Update workweek scheme

Path params

JSON body fields

DayOfWeek

WorkweekSchemeType

PUT

PUT

Assign workweek scheme to users

JSON body fields

Responses

DELETE

Path

Delete workweek scheme

Permissions

Path params

Path params