Overview

Each vacation type could have defined default vacation definitions - automatically assigned vacation days for new users.

...

Table of Contents

minLevel	1
maxLevel	2

POST

Create default vacation definition

Creates default vacation definition for vacation type

...

Methods

POST

...

title	Create default vacation definition

Creates default vacation definition for vacation type.

...

.

Permissions:

Status

colour	Green
title	ADMIN

Status

colour	Red
title	USER

Status

colour	Red
title	SUPERVISOR

Status

colour	Red
title	HR

Code Block
POST {jira_baseurl}/rest/vacation-manager/1.0/default-vacation-definition Permissions

Responses:

Status

title
colour	Green

...

201

Status

colour

...

title
Yellow

...

404

Status

title
colour	Red

...

500

JSON body fields

Name	Type	Description
id	int	Object Id
vacationTypeId	int	Vacation Type Id
daysCountLimit	double	Number of days that will be assigned to user
defaultPeriodType	VacationTypeDefaultPeriodType	One of values: ONE_TIME_DYNAMIC_DAYS_OFFSET ONE_TIME_FIXED_DAYS_OFFSET RECURRING_PERIOD_OFFSET RECURRING_DYNAMIC_OFFSET RECURRING_FIXED_OFFSET
dynamicOffset	String	Start date offset of vacation days after user is added to Vacation Manager, 1m 1w 1d format (required for DYNAMIC defaultPeriodType)
dynamicDays	int	End date offset from dynamicOffset (required for DYNAMIC defaultPeriodType)
fixedStartDate	String	Start date of vacation days, YYYY-MM-DD format (required for FIXED defaultPeriodType)
fixedEndDate	String	End date of vacation days, YYYY-MM-DD format (required for FIXED defaultPeriodType)
periodOffset	int	Start date offset in periods for new vacation days. 0 - current period -1, -2... - previous periods 1, 2... - next periods (required for PERIOD defaultPeriodType)

Responses

Status
colour	Green
title	201

Status

colour	Yellow
title	404

Status

colour	Red
title	500

Example

Expand

title	Example

Code Block

title	Path

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

Code Block

title	Body

{
  "vacationTypeId": 2,
  "daysCountLimit": 20,
  "defaultPeriodType": "RECURRING_PERIOD_OFFSET",
  "periodOffset": 2
}

Code Block

title	Response

{
  "id": 2,
  "vacationTypeId": 2,
  "daysCountLimit": 20.0,
  "defaultPeriodType": "RECURRING_PERIOD_OFFSET",
  "periodOffset": 2
}

...

GET

...

Get all default vacation definitions

Returns list of all default vacation definitions

...

Path

...

.

...

Permissions:

Status

colour	Green
title	ADMIN

Status

colour	Red
title	USER

Status

colour	Red
title	SUPERVISOR

Status

colour	Red
title	HR

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

Responses:

Status

colour	Green
title	200

Status

colour	Red
title	500

...

Expand

title	Example

...

title

Expand

Code Block

title	Path

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

Code Block

title	Response

[
    {
        "id": 1,
        "vacationTypeId": 1,
        "daysCountLimit": 1.0,
        "defaultPeriodType": "ONE_TIME_DYNAMIC_DAYS_OFFSET",
        "dynamicOffset": "1",
        "dynamicDays": 1
    },
    {
        "id": 2,
        "vacationTypeId": 2,
        "daysCountLimit": 20.0,
        "defaultPeriodType": "RECURRING_PERIOD_OFFSET",
        "periodOffset": 2
    }
]

...

Get default vacation definition object by Id

Returns default vacation definition object by its Id.

...

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

...

Permissions:

Status

colour	Green
title	ADMIN

Status

colour	Red
title	USER

Status

colour	Red
title	SUPERVISOR

Status

colour	Red
title	HR

Path paramsResponses

Name	Type	Description
defaultVacationDefinitionId	int	Id of default vacation definition object
Code Block
GET {jira_baseurl}/rest/vacation-manager/1.0/default-vacation-definition/{defaultVacationDefinitionId}

Responses:

Status

colour	Green
title	200

Status

colour	Yellow
title	404

Status

colour	Red
title	500

...

Path params

Name	Type	Description
defaultVacationDefinitionId	int	Id of default vacation definition object

Expand

title	Example

Code Block

title	Path

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

Code Block

title	Response

{
    "id": 1,
    "vacationTypeId": 1,
    "daysCountLimit": 1.0,
    "defaultPeriodType": "ONE_TIME_DYNAMIC_DAYS_OFFSET",
    "dynamicOffset": "1",
    "dynamicDays": 1
}

...

Get default vacation

...

definition object by Vacation Type

Returns default vacation definition object by Vacation Type that it's assigned to

...

Path

...

.

...

Permissions:

Status

colour	Green
title	ADMIN

Status

colour	Red
title	USER

Status

colour	Red
title	SUPERVISOR

Status

colour	Red
title	HR

Path paramsResponses

Name	Type	Description
vacationTypeId	int	Id of vacation type
Code Block
GET {jira_baseurl}/rest/vacation-manager/1.0/default-vacation-definition/vacation-type/{vacationTypeId}

Responses:

Status

colour	Green
title	200

Status

colour	Yellow
title	404

Status

colour	Red
title	500

...

Path params

Name	Type	Description
vacationTypeId	int	Id of vacation type

Expand

title	Example

Code Block

title	Path

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

Code Block

title	Response

[
    {
        "id": 1,
        "vacationTypeId": 1,
        "daysCountLimit": 1.0,
        "defaultPeriodType": "ONE_TIME_DYNAMIC_DAYS_OFFSET",
        "dynamicOffset": "1",
        "dynamicDays": 1
    }
]

...

PUT

...

Update default vacation definition

Updates and returns default vacation definition object.

...

Permissions:

Status

colour	Green
title	ADMIN

Status

colour	Red
title	USER

Status

colour	Red
title	SUPERVISOR

Status

colour	Red
title	HR

Code Block
PUT {jira_baseurl}/rest/vacation-manager/1.0/default-vacation-definition/{defaultVacationDefinitionId} Permissions

Responses:

Status

title
colour	Green

...

200

Status

colour

...

title
Yellow

...

400

Status

colour

...

title
Yellow

...

404

Status

title
colour	Red

...

500

Path params

Name	Type	Description
defaultVacationDefinitionId	int	Id of default values object to update

JSON body fields

Same as in create default values endpoint.

...

Status

colour	Green
title	200

StatuscolourYellowtitle400

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/default-vacation-definition/2

Code Block

title	Body

{
  "vacationTypeId": 2,
  "daysCountLimit": 25,
  "defaultPeriodType": "RECURRING_PERIOD_OFFSET",
  "periodOffset": 2
}

Code Block

title	Response

{
    "id": 2,
    "vacationTypeId": 2,
    "daysCountLimit": 25.0,
    "defaultPeriodType": "RECURRING_PERIOD_OFFSET",
    "periodOffset": 2
}

...

DELETE

...

Delete default vacation

...

definition object by Id

Deletes default vacation definition object

...

Path

...

.

...

Permissions:

Status

colour	Green
title	ADMIN

Status

colour	Red
title	USER

Status

colour	Red
title	SUPERVISOR

Status

colour	Red
title	HR

Path params

Responses

Name	Type	Description
defaultVacationDefinitionId	int	Id of default values object
Code Block
DELETE {jira_baseurl}/rest/vacation-manager/1.0/default-vacation-definition/{defaultVacationDefinitionId}

Responses:

Status

colour	Green
title	204

Status

colour	Yellow
title	404

Status

colour	Red
title	500

Path params

Name	Type	Description
defaultVacationDefinitionId	int	Id of default values object

Expand

title	Example

Code Block

title	Path

DELETE {jira_baseurl}/rest/vacation-manager/1.0/default-vacation-definition/3

...

Delete default vacation definition object for vacation type

Deletes default values object for given vacation type.

...

Permissions:

Status

colour	Green
title	ADMIN

Status

colour	Red
title	USER

Status

colour	Red
title	SUPERVISOR

Status

colour	Red
title	HR

Code Block
DELETE {jira_baseurl}/rest/vacation-manager/1.0/default-vacation-definition/vacation-type/{vacationTypeId} Permissions

Responses:

Status

title
colour	Green

...

204

Status

colour

...

title
Yellow

...

404

Status

title
colour	Red

...

500

Path params

Name	Type	Description
vacationTypeId	int	Id of vacation type object to delete default values object from

...

Responses

...

Status

colour	Yellow
title	404

...

Expand

title	Example

Code Block

title	Path

DELETE {jira_baseurl}/rest/vacation-manager/1.0/default-vacation-definition/vacation-type/5

Versions Compared

Old Version 3

New Version 4

Key

Overview

POST

Create default vacation definition

Methods

JSON body fields

Responses

Example

GET

...

Get all default vacation definitions

Path

Get default vacation definition object by Id

Path params

Get default vacation

definition object by Vacation Type

Path

Path params

PUT

Update default vacation definition

Path params

JSON body fields

Example

DELETE

...

Delete default vacation

definition object by Id

Path

Path params

Path params

Delete default vacation definition object for vacation type

Path params

Responses

Page Comparison

Versions Compared

Old Version 3

New Version 4

Key

Overview

POST

Create default vacation definition

Methods

JSON body fields

Responses

Example

GET

...

Get all default vacation definitions

Path

Get default vacation definition object by Id

Path params

Get default vacation

definition object by Vacation Type

Path

Path params

PUT

Update default vacation definition

Path params

JSON body fields

Example

DELETE

...

Delete default vacation

definition object by Id

Path

Path params

Path params

Delete default vacation definition object for vacation type

Path params

Responses