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

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

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

Path

Code Block
title

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

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

Code Block

title	Response

...

Get single workweek scheme

Returns information about existing workweek scheme

...

Path

...

.

...

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

Path

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

Code Block

title	Path

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.

...

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

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

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

Code Block

title	Path

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

...

POST

...

Create

...

new workweek scheme

Creates and returns new workweek scheme.

...

Path

...

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

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

StatuscolourYellow Expand

title

400

Status

colour	Red
title	500

Example

expand

Path

title	Example

Code Block

title

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

Body

Code Block

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

Response

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

Code Block

	Response

...

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

Responses

Status
colour	Green
title	200

Status

colour	Yellow
title	400

StatuscolourYellowtitle404

Status

colour	Red
title	500

Example

Expand

title	Example

Code Block

title	Path

Expand

title	Example

Path

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

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	Body

Response

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

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}

DELETE

...

Expand

title	Delete workweek scheme

Deletes existing workweek scheme.

/rest/vacation-manager/1.0/vacman-user/workweek/bulk

Responses:

Status

colour	Green
title	200

Status

colour	Yellow
title	400

Status

colour	Yellow
title	404

Status

colour	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

Responses

Expand

title	Example

Path

Code Block
DELETEPUT {jira_baseurl}/rest/vacation-manager/1.0/vacman-user/workweek-scheme/{schemeId}

Permissions

ADMIN USER SUPERVISOR HR

Path params

Name

Type

Description

schemeId

int

Scheme ID

/bulk

Body

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

Response

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

...

DELETE

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

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

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 3

New Version Current

Key

<span class="diff-html-removed" data-a11y-before="Start of deleted content" data-a11y-after="End of deleted content" id="removed-diff-0">[data-colorid=wjfpr8oso5]{color:#091e42} html[data-color-mode=dark] [data-colorid=wjfpr8oso5]{color:#bdd2f6}</span>Overview

Methods:

GET

GET

Get workweek schemes list

Path

Path

Response

Get single workweek scheme

Path

Path param

Path

Response

Get workweek scheme for user

Query params

Query params

Path

Response

POST

Create

new workweek scheme

Path

JSON body fields

DayOfWeek

WorkweekSchemeType

Responses

Path

Body

Response

PATCH

Update workweek scheme

Path params

JSON body fields

DayOfWeek

WorkweekSchemeType

Example

Path

Body

Response

PUT

Assign workweek scheme to users

DELETE

JSON body fields

Path

Permissions

Path params

Body

Response

DELETE

Delete workweek scheme

Path params

Path

Overview