Page Comparison

...

Overview

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

Methods:

GET

Anchor

	getList
	getList

Expand

title	Get workweek schemes list

Returns list of workweek schemes.

Path

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

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	Yellow
title	400

Status

colour	Red
title	500

Example

Expand

title	Example

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

...

Expand

title	Get workweek scheme for user

Returns workweek scheme used by given user.

Path

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

Permissions

Status

colour	Green
title	ADMIN

Status
colour Red
title USER

Status
colour Red
title SUPERVISOR

Status
colour Green
title HR

Query params

Name	Type	Description
userName	String	User Name

Responses

Status

colour	Green
title	200

Status

colour	Yellow
title	400

Status

colour	Red
title	500

Example

Expand

title	Example

Code Block

title	Path

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

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

Anchor
Create
Create

Expand

title	Create new workweek scheme

Creates and returns new workweek scheme.

Path

Code Block

title	Request /workweek-scheme

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

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

Example

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

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

Anchor

	update
	update

Expand

title	Update workweek scheme

Update and return existing workweek scheme.

Path

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

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

Responses

Status


colour	Green
title	200

Status

colour	Yellow
title	400

Status


colour	Yellow
title	404

Status

colour	Red
title	500

Example

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

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

Anchor

	assignToUsers
	assignToUsers

Expand

title	Assign workweek scheme to users

Assigns workweek scheme to users.

Path

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

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

Responses

Status


colour	Green
title	200

Status

colour	Yellow
title	400

Status


colour	Yellow
title	404

Status

colour	Red
title	500

Example

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

Anchor
Delete
Delete

Expand

title	Delete workweek scheme

Deletes existing workweek scheme.

Path

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	Scheme ID

Responses

Status


colour	Green
title	204

Status


colour	Yellow
title	404

Status

colour	Red
title	500

Example

Expand

title	Example

Code Block

title	Path

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

...

Page Comparison

Versions Compared

Old Version 8

New Version 9

Key

<span class="diff-html-changed" data-a11y-before="Start of changed content" data-a11y-after="End of changed content" id="changed-diff-0">[data-colorid=</span>

Methods:

GET

Path

Permissions

Responses

Example

Path

Permissions

Query params

Responses

Example

POST

AnchorCreateCreate

Path

Permissions

JSON body fields

DayOfWeek

WorkweekSchemeType

Responses

Example

PATCH

Path

Permissions

StatuscolourGreentitleADMIN StatuscolourRedtitleUSER StatuscolourRedtitleSUPERVISOR StatuscolourGreentitleHRPath params

JSON body fields

DayOfWeek

WorkweekSchemeType

Example

PUT

Path

Permissions

JSON body fields

Responses

Example

DELETE

AnchorDeleteDelete

Path

Permissions

Path params

Responses

Example

Anchor
Create
Create

Status
colour Green
title ADMIN

Status
colour Red
title USER

Status
colour Red
title SUPERVISOR

Status
colour Green
title HR

Path params

Anchor
Delete
Delete