Overview

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

Methods

GET

Get vacation definition

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

Path

GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/{userName}?vacationTypeId={vacationTypeId}

Permissions

ADMIN USER SUPERVISOR HR

Path params

Name	Type	Description
userName	String	User name

Query params

Name	Type	Description
vacationTypeId	int	Vacation type Id

Responses

200 400 500

Example

Path

GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/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
  }
]

POST

Create vacation definition

Creates and returns vacation definition.

Path

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

Permissions

ADMIN USER SUPERVISOR HR

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

201 400 500

Example

Path

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

Body

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

Response

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

PUT

update vacation definition

Returns and updates vacation definition.

Path

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

Permissions

ADMIN USER SUPERVISOR HR

Path params

Name	Type	Description
vacationDefinitionId	int	Vacation definition ID

JSON body fields

Name	Type	Description
dayLimit	double	Day limit

Responses

200 400 500

Example

Path

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

Body

{
    "dayLimit": 2
}

Response

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

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

Permissions

ADMIN USER SUPERVISOR HR

Path params

Name	Type	Description
vacationDefinitionId	int	Vacation definition ID

Responses

204 404 500

Example

Path

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

[REST 1.1] Vacation definitions

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

Methods

GET

Path

Permissions

Path params

Query params

Responses

Example

POST

Path

Permissions

JSON body fields

Responses

Example

PUT

Path

Permissions

Path params

JSON body fields

Responses

Example

DELETE

Path

Permissions

Path params

Responses

Example