Page Comparison

...

Name	Type	Description
vacationTypeId	int	Vacation type Id

Expand

title	Example

Path

Code Block
title

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

Response

Code Block

title

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

...

Name	Type	Description
vacationDefinitionId	int	Vacation definition ID

Expand

title	Example

Path

title

Code Block

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

Response

Code Block

title	Response

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

...

Name	Type	Description
vacationDefinitionId	int	Vacation definition ID

Expand

title	Example

Path

Code Block

title	Path

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

Response

Code Block

title	Response

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

...

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"

Expand

title	Example

Path

title

Code Block

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

Body

title

Code Block

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

Response

Code Block
title

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

...

Name	Type	Description
dayLimit	double	Day limit

Expand

title	Example

Path

Code Block

title	Path

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

Body

Code Block
title

{ "dayLimit": 2 }

Response

Code Block

title	Response

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

...

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

Versions Compared

Old Version 15

New Version Current

Key

Path

Response

Path

Response

Path

Response

Path

Body

Response

Path

Body

Response

Path