Overview

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

create vacation definition
get vacation definition for user
get vacation definition by ID
get vacation instances for given vacation definition
update vacation definition
delete vacation definition

Methods

GET

...

Table of Contents

minLevel	1
maxLevel	2

GET

Get vacation definition

Returns all vacation definitions for current user or only selected one vacation definition.

...

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/vacation-definition/user/{userName}?vacationTypeId={vacationTypeId} Permissions

Responses:

Status

title
colour	Green

...

200

Status

colour

...

title
Yellow

...

400

Status

title
colour	Red

...

Status

colour	Green
title	HR

500

Path params

Name	Type	Description
userName	String	User name

Query params

Name	Type	Description
vacationTypeId	int	Vacation type Id

Responses

Green

Status

colour

Expand

title

200

Status

colour	Yellow
title	400

Status

colour	Red
title	500

Example

Expand

title	Example

Code BlocktitlePath

Example

Path

Code Block
GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/user/userName

Response

[
  {
    "id": 1,
    "vacationTypeId": 1,
    "userId": "1",
	"userName": "userName",
    "vacationKindName": "vacation kind name 1",
    "startDate": "2018-10-18",
    "dayLimit": 0
  },
  {
    "id": 2,
    "vacationTypeId": 2,
	"userName": "userName",
    "vacationKindName": "vacation kind name 2",
    "startDate": "2018-10-30",
    "dayLimit": 23
  }
]

Code Block

title	Response

...

Get vacation definition with given ID

Returns vacation definition with given ID

Path

Code Block
GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/{vacationDefinitionId}

...

Permissions:

Status

colour	Green
title	ADMIN

Status

colour	Red
title	USER

Status

colour	Red
title	SUPERVISOR

Status

colour	Green
title	HR

Path params

Responses

Name	Type	Description
vacationDefinitionId	int	Vacation definition ID
Code Block
GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/{vacationDefinitionId}

Responses:

Status

colour	Green
title	200

Status

colour	Yellow
title	400

Status

colour	Red
title	500

...

Path params

Name	Type	Description
vacationDefinitionId	int	Vacation definition ID

Expand

title	Example

Path

GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/1

Code Block

title	Path

Response

[
  {
    "id": 1,
    "vacationTypeId": 1,
    "userId": 10000,
    "vacationTypeName": "remote",
    "startDate": "2021-02-01",
    "dayLimit": 0
}
]

Code Block

title	Response

...

Expand

title

Get vacation instances for vacation definition

Returns list of vacation instances for given vacation definition,

...

Path

...

Permissions:

Status

colour	Green
title	ADMIN

Status

colour	Red
title	USER

Status

colour	Red
title	SUPERVISOR

Status

colour	Green
title	HR

Path params

Responses

Name	Type	Description
vacationDefinitionId	int	Vacation definition ID
Code Block
GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/{vacationDefinitionId}/vacation-instance

Responses:

Status

colour	Green
title	200

Status

colour	Yellow
title	400

Status

colour	Red
title	500

...

Path params

Name	Type	Description
vacationDefinitionId	int	Vacation definition ID

Expand

title	Example

Path

GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/6/vacation-instance

Code Block

title	Path

Response

title

[
  {
    "id": 8,
    "startDate": "2021-01-01",
    "endDate": "2021-01-31",
    "availableDays": 5,
    "availableMinutes": 0,
    "entitledDays": 5,
    "carryOverDays": 0,
    "carryOverMinutes": 0,
    "usedDays": 0,
    "usedMinutes": 0,
    "vacationDocuments": [],
    "vacationDefinitionId": 6,
    "remainingCarryOverDays": 0,
    "remainingCarryOverMinutes": 0
  },
  {
    "id": 9,
    "startDate": "2021-02-01",
    "endDate": "2021-02-28",
    "availableDays": 10,
    "availableMinutes": 0,
    "entitledDays": 5,
    "carryOverDays": 5,
    "carryOverMinutes": 0,
    "usedDays": 0,
    "usedMinutes": 0,
    "vacationDocuments": [],
    "vacationDefinitionId": 6,
    "remainingCarryOverDays": 5,
    "remainingCarryOverMinutes": 0
  },
  {
    "id": 10,
    "startDate": "2021-03-01",
    "endDate": "2021-03-31",
    "availableDays": 5,
    "availableMinutes": 0,
    "entitledDays": 5,
    "carryOverDays": 0,
    "carryOverMinutes": 0,
    "usedDays": 0,
    "usedMinutes": 0,
    "vacationDocuments": [],
    "vacationDefinitionId": 6,
    "remainingCarryOverDays": 0,
    "remainingCarryOverMinutes": 0
  }
]

Code Block

	Response

...

POST

...

Create vacation definition

Creates and returns vacation definition.

...

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/vacation-definition 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
vacationTypeId	Integer	vacation type id
userName	String	username to which dew vacation definition will be assigned
startDate	String	Date when user is enabled to request vacation using this definition. ISO 8601 format.
endDate	String	Date when one time vacation type no longer enables user to request vacation using it. Must be used only when vacation has valid through option enabled.

...

ISO 8601 format.
dayLimit	Double	Default day limit. Should be integer when vacation is "daily only" or "daily or hourly". May contain additional half if vacation is "daily or half daily"

Responses

Green201

Status

colour

Expand

title

Status

colour	Yellow
title	400

Status

colour	Red
title	500

Example

expand

Path

title

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

title	Example

Code Block

Path

Body

{
  "vacationTypeId":"1",
  "userName": "userName",
  "startDate": "2018-09-10",
  "endDate": "2018-09-20",
  "dayLimit": 5
}

Code Block

title	Body

Response

{
  "id": 8,
  "vacationTypeId": 1,
  "userName": "userName",
  "vacationKindName": "Vacation kind name",
  "startDate": "2018-09-10",
  "endDate": "2018-09-20",
  "dayLimit": 5
}

Code Block

title	Response

...

PUT

...

Update vacation definition

Returns and updates vacation definition.

...

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/vacation-definition/{vacationDefinitionId} Permissions

Responses:

Status

title
colour	Green

...

200

Status

colour

...

title
Yellow

...

400

Status

title
colour	Red

...

Status

colour	Green
title	HR

500

Path params

Name	Type	Description
vacationDefinitionId	int	Vacation definition ID

JSON body fields

Name	Type	Description
dayLimit	double	Day limit

Responses

Green

Status

colour

Expand

title

200

Status

colour	Yellow
title	400

Status

colour	Red
title	500

Example

expand

Path

PUT {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/2

title	Example

Code Block

title	Path

Body

{
    "dayLimit": 2
}

Code Block

title	Body

Response

Code Block
title

{ "id": 2, "vacationTypeId": 2, "userName": "userName", "vacationKindName": "vacation kind name 2", "startDate": "2018-10-30", "dayLimit": 2 }

...

DELETE

...

Delete vacation definition

Deletes vacation definition.

Path

Code Block
delete {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/{vacationDefinitionId}

...

Permissions:

Status

colour	Green
title	ADMIN

Status

colour	Red
title	USER

Status

colour	Red
title	SUPERVISOR

Status

colour	Green
title	HR

Path params

Responses

Name	Type	Description
vacationDefinitionId	int	Vacation definition ID
Code Block
delete {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/{vacationDefinitionId}

Responses:

Status

colour	Green
title	204

Status

colour	Yellow
title	404

Status

colour	Red
title	500

...

Path params

Name	Type	Description
vacationDefinitionId	int	Vacation definition ID

Expand

title	Example

Path

Code Block
title

DELETE {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/1

Page Comparison

Versions Compared

Old Version 12

New Version Current

Key

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

Methods

GET

GET

Get vacation definition

Path params

Query params

Responses

Example

Path

Response

Get vacation definition with given ID

Path

Path params

Path params

Path

Response

Get vacation instances for vacation definition

Path

Path params

Path params

Path

Response

POST

...

Create vacation definition

JSON body fields

Responses

Path

Body

Response

PUT

Update vacation definition

Path params

JSON body fields

Responses

Path

Body

Response

DELETE

...

Delete vacation definition

Path

Path params

Path params

Path