Versions Compared

Old Version 6

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

Saved on

compared with

New Version 7

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

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

Anchor
getVacationDefinition
getVacationDefinition

Expand
titleGet vacation definition

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

Path

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

Permissions

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

Path params

NameTypeDescription
userNameStringUser name

Query params

NameTypeDescription
vacationTypeIdintVacation type Id

Responses

Status
colourGreen
title200
 
Status
colourYellow
title400
 
Status
colourRed
title500

Example

Expand
titleExample


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


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



Anchor
getVacationDefinitionByID
getVacationDefinitionByID

Expand
titleGet 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
colourGreen
titleADMIN
 
Status
colourRed
titleUSER
 
Status
colourRed
titleSUPERVISOR
 
Status
colourGreen
titleHR

Path params

NameTypeDescription
vacationDefinitionIdintVacation definition ID

Responses

Status
colourGreen
title200
 
Status
colourYellow
title400
 
Status
colourRed
title500

Example

Expand
titleExample


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


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



...

Expand
titleCreate vacation definition

Creates and returns vacation definition.

Path

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

Permissions

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

JSON body fields

NameTypeDescription

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 Block
titlePath
POST {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition


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


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



...