Overview

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

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

title
colour	Green

...

	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

...

Expand

title	Example

...

expand

Path

Code Block
title

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

Response

Code Block

title

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

...

title

Get single workweek scheme

Returns information about existing

...

Path

...

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

...

title

Expand

Path

Code Block
title

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

Response

Code Block

title

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

...

Get workweek scheme for user

Returns workweek scheme used by given user

...

Path

...

.

...

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

Path

title

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

Code Block

	Path

Response

Code Block
title

...

Expand

title	Create new workweek scheme

Creates and returns new workweek scheme.

Path

Request /workweek-scheme

Code Block

title

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

Code Block

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

scheme

Permissions

Status

colour	Green
title	ADMIN

scheme

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_EACH_DAY	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

...

Expand

title	Example

Path

title

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

Code Block

	Path

Body

title

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

Code Block

	Body

Response

...

Expand

title	Update workweek scheme

Update and return existing workweek scheme.

PathResponse

Code Block

title

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

...

_EACH_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_EACH_DAY	Enum	Type of separate work minutes for each day

...

Status

colour	Yellow
title	400

...

Status

colour	Red
title	500

...

Expand

title	Example

Path

title

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

Code Block

	Path

Body

title

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

Code Block

	Body

Response

...

Expand

title	Assign workweek scheme to users

Assigns workweek scheme to users.

PathResponse

Code Block

title

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

...

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

Permissions

...

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

JSON body fields

Responses

Name	Type	Description
schemeId	Integer	Id of workweek scheme you want to assign to users
userNames	Array<String>	Names of users you want to assign workweek scheme to
Code Block
PUT {jira_baseurl}/rest/vacation-manager/1.0/vacman-user/workweek/bulk

Responses:

Status

colour	Green
title	200

Status

colour

...

title
Yellow

...

400

Status

title
colour	Yellow

...

404

Status

colour

...

Status

colour	Red
title	500

...

	Red
title	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 to

Expand

title	Example

Path

Code Block
title

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

Body

Code Block
title

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

Response

Code Block
title

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

...

DELETE

...

title	Delete workweek scheme

Deletes existing workweek scheme.

...

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

int

Code Block

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

Permissions

ADMIN USER SUPERVISOR HR

Path params

Name

Type

Description

schemeId

Scheme ID

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

Path

Code Block
title

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

Page Comparison

Versions Compared

Old Version 9

New Version Current

Key

Methods:

GET

GET

Get workweek schemes list

Path

Path

Response

Get single workweek scheme

Path

Path param

Path

Response

Get workweek scheme for user

Path

Query params

Query params

Path

Response

Path

POST

POST

Create new workweek scheme

Permissions

JSON body fields

DayOfWeek

WorkweekSchemeType

Responses

Path

Body

Response

PATCH

PATCH

Update workweek scheme

Path params

JSON body fields

DayOfWeek

WorkweekSchemeType

Path

Body

Response

PUT

PUT

Assign workweek scheme to users

JSON body fields

JSON body fields

Path

Body

Response

DELETE

Delete workweek scheme

Permissions

Path params

Path params

Path