Versions Compared

Old Version 5

changes.mady.by.user Marcin Wikarski (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Łukasz Modzelewski

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

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

Methods

GET

...

Table of Contents
minLevel1
maxLevel2

GET

Get vacation definition

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

...

Permissions:

Status
colourGreen
titleADMIN
 
Status
colourRed
titleUSER
 
Status
colourRed
titleSUPERVISOR
 
Status
colourGreen
titleHR

Code Block
GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/user/{userName}?vacationTypeId={vacationTypeId}
Permissions

Responses:

Status
colourGreen
title

...

200
 
Status
colour

...

Yellow
title

...

400
 
Status
colourRed
title

...

Status
colourGreen
titleHR

500

Path params

Name

Type

Description

userName

String

User name

Query params

Name

Type

Description

vacationTypeId

int

Vacation type Id

Responses

Status
colourGreen
title200
 
Status
colourYellow
title400
 
Status
colourRed
title500

Example

Expand
titleExample
Code Block
titlePath
Expand
titleExample
title
Path
Code Block
GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/user/userName
Response
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
  }
]
Code Block
Response
Expand
Get vacation definition with given ID
Returns vacation definition with given ID
...
Path
...
...
GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/{vacationDefinitionId}
...
Permissions: 
 Status
colourGreen
titleADMIN
 
 Status
colourRed
titleUSER
 
 Status
colourRed
titleSUPERVISOR
 
 Status
colourGreen
titleHR
Path params
Responses
NameTypeDescription
vacationDefinitionIdintVacation definition ID
 Code Block
GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/{vacationDefinitionId}
Responses: 
 Status
colourGreen
title200
 
 Status
colourYellow
title400
 
 Status
colourRed
title500
...
Path params
Name
Type
Description
vacationDefinitionId
int
Vacation definition ID
Get 
 Expand
titleExample
Path
GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/1
 Code Block
titlePath
Response
[
  {
    "id": 1,
    "vacationTypeId": 1,
    "userId": 10000,
    "vacationTypeName": "remote",
    "startDate": "2021-02-01",
    "dayLimit": 0
}
]
 Code Block
titleResponse
 Expand
title
Get vacation instances for vacation definition
...
Returns list of vacation instances for given vacation definition,
...
Path
...
Permissions: 
 Status
colourGreen
titleADMIN
 
 Status
colourRed
titleUSER
 
 Status
colourRed
titleSUPERVISOR
 
 Status
colourGreen
titleHR
Path params
Responses
NameTypeDescription
vacationDefinitionIdintVacation definition ID
 Code Block
GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/{vacationDefinitionId}/vacation-instance
Responses: 
 Status
colourGreen
title200
 
 Status
colourYellow
title400
 
 Status
colourRed
title500
...
Path params
Name
Type
Description
vacationDefinitionId
int
Vacation definition ID
 Expand
titleExample
Path
GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/6/vacation-instance
 Code Block
titlePath
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
  }
]
 Code Block
titleResponse
...
POST
...
...
Create vacation definition
Creates and returns vacation definition.
...
Permissions: 
 Status
colourGreen
titleADMIN
 
 Status
colourRed
titleUSER
 
 Status
colourRed
titleSUPERVISOR
 
 Status
colourGreen
titleHR
 Code Block
POST {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition
Permissions
Responses: 
 Status
colourGreen
title
...
201
 
 Status
colour
...
Yellow
title
...
400
 
 Status
colourRed
title
...
 Status
colourGreen
titleHR
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
 Status
colourGreen
title201
 
 Status
colourYellow
title400
 
 Status
colourRed
title500
Example
 Expand
titleExample
 Code BlocktitlePath Expand
titleExample
Path
 Code Block
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
}
 Code Block
titleBody
Response
{
  "id": 8,
  "vacationTypeId": 1,
  "userName": "userName",
  "vacationKindName": "Vacation kind name",
  "startDate": "2018-09-10",
  "endDate": "2018-09-20",
  "dayLimit": 5
}
 Code Block
titleResponse
...
PUT
...
Update vacation definition
Returns and updates vacation definition.
...
Permissions: 
 Status
colourGreen
titleADMIN
 
 Status
colourRed
titleUSER
 
 Status
colourRed
titleSUPERVISOR
 
 Status
colourGreen
titleHR
 Code Block
PUT {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/{vacationDefinitionId}
Permissions
Responses: 
 Status
colourGreen
title
...
200
 
 Status
colour
...
Yellow
title
...
400
 
 Status
colourRed
title
...
 Status
colourGreen
titleHR
500
Path params
Name
Type
Description
vacationDefinitionId
int
Vacation definition ID
JSON body fields
Name
Type
Description
dayLimit
double
Day limit
Responses
 Status
colourGreen
title200
 
 Status
colourYellow
title400
 
 Status
colourRed
title500
Example
 Expand
titleExample
 Code Block
titlePath
 Expand
titleExample
Path
 Code Block
PUT {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/2
Body
title
{
    "dayLimit": 2
}
 Code Block
Body
Response
title
{
  "id": 2,
  "vacationTypeId": 2,
  "userName": "userName",
  "vacationKindName": "vacation kind name 2",
  "startDate": "2018-10-30",
  "dayLimit": 2
}
 Code Block
Response
...
DELETE
...
Delete vacation definition
Deletes vacation definition.
Path
 Code Block
delete {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/{vacationDefinitionId}
...
Permissions: 
 Status
colourGreen
titleADMIN
 
 Status
colourRed
titleUSER
 
 Status
colourRed
titleSUPERVISOR
 
 Status
colourGreen
titleHR
Path params
Responses
NameTypeDescription
vacationDefinitionIdintVacation definition ID
 Code Block
delete {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/{vacationDefinitionId}
Responses: 
 Status
colourGreen
title204
 
 Status
colourYellow
title404
 
 Status
colourRed
title500
...
Path params
Name
Type
Description
vacationDefinitionId
int
Vacation definition ID
 Expand
titleExample
Path
Path
 Code Block
title
DELETE {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/1