[REST 1.1] Vacation types

Owned by Marcin Wikarski (Unlicensed)
Last updated: 11/Mar/24 by Piotr Wasiak
3 min read

GET

Get single vacation type

Returns information about specific vacation type.

Permissions: ADMIN USER SUPERVISOR HR

GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-type/{vacationTypeId}

Responses: 200 404 500

Path params

Name

Type

Description

Name

Type

Description

vacationTypeId

int

Vacation type Id

Path

GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-type/1
Response
{ "id": 1, "name": "name", "issueTypeId": "1", "vacationKindType": "ONE_TIME", "validThrough": false, "hasDayLimit": false, "carryOver": false, "description": "", "vacationDocumentPeriodType": "DAILY" }

Get vacation types list

Returns information about all vacation type.

Permissions: ADMIN USER SUPERVISOR HR

Responses: 200 500

Path
Response

Get vacation type update information

Returns information required for update about specific vacation type.

Permissions: ADMIN USER SUPERVISOR HR

Responses: 200 404 500

Path params

Name

Type

Description

Name

Type

Description

vacationTypeId

int

Vacation type Id

Path

Response

POST

Create vacation type

Creates and returns new vacation type.

Permissions: ADMIN USER SUPERVISOR HR

Response: 201 400 500

JSON body fields

Name

Type

Description

Name

Type

Description

name

String

Name of new vacation type (this is also name for issue type associated with that new vacation type).

description

String (optional)

Description of vacation type.

kindType

KindType

Kind of new vaction type.

vacationDocumentPeriodType

VacationDocumentPeriodType

Type of available vacation document period.

periodDefinition

Object (required if kindType is RECURRING)

PeriodDefinition object for recurring vacation type.

hasCarryOver

bool (required if kindType is RECURRING)

Specifies if unused days will be transferred to new vacation periods.

hasEndDate

bool (required if kindType is ONE_TIME)

Specifies if assigned vacation days will be having expiration date.

hasDayLimit

bool (required if kindType is ONE_TIME)

Specifies if there will be limit of days that user can use in this vacation type.

defaultDayLimit

int

Default vacation days limit for vacation type. This value will be suggested when HR will be assigning new vacation days for users.

useWorklog

bool

Save used time to worklog.

carryoverClearPeriodDefinition

Object (optional if kindType is RECURRING)

CarryoverClearPeriodDefinition object for recurring vacation type. Specifies period after carryover days will be cleared.

PeriodDefinition

Name

Type

Description

Name

Type

Description

type

PeriodDefinitionType

Type of recurring period.

Currently only monthly period is available.

value

int

Number of months in recurring period.

Valid values: 1, 2, 3, 4, 6, 12

startDate

Date

Date of when period will start. ISO 8601 format.

VacationDocumentPeriodType

Name

Type

Description

Name

Type

Description

DAILY

Enum

Vacation type for daily vacations

DAILY_OR_HALF_DAILY 

Enum

Vacation type for daily and half daily vacations

DAILY_OR_HOURLY

Enum

Vacation type for hourly vacations

KindType

Name

Type

Description

Name

Type

Description

ONE_TIME

Enum

Vacation kind type for one time vacations

RECURRING

Enum

Vacation kind  type for recurring vacations

PeriodDefinitionType

Name

Type

Description

Name

Type

Description

MONTHS

Type of monthly recurring period

CarryoverClearPeriodDefinition

Name

Type

Description

Name

Type

Description

type

CarryoverClearPeriodDefinitionType

Type of carryover days clear period.

Currently only daily period is available.

value

int

Number of days in carryover days clear period.

CarryoverClearPeriodDefinitionType

Name

Type

Description

Name

Type

Description

DAYS

Type of daily carryover days clear period.

Path

Body
Response 

PUT

Update vacation type

Updates and returns vacation type.

Permissions: ADMIN USER SUPERVISOR HR

Responses: 200 400 404 500

Path params

Name

Type

Description

Name

Type

Description

vacationTypeId

int

Vacation type Id

JSON body fields

Name

Type

Description

Name

Type

Description

vacationDocumentPeriodType

VacationDocumentPeriodType

Type of vacation requests period.

changeHalfDaysToFullDays

Boolean (optional)

When changing vacation type from "daily or half-daily" to "daily only", this option allows to convert half day left over to full day

minutesCountToChangeToFullDays

Integer (optional)

When changing vacation type from "daily or hourly" to "daily only", this option allows to specify how many minutes is required to grant full day off when somebody has spare minutes or hours

minutesCountToChangeToHalfDays

Integer (optional)

When changing vacation type from "daily or hourly" to "daily or half-daily", this option allows to specify how many minutes is required to grant half day off when somebody has spare minutes or hours

minutesCountToGetFromHalfDays

Integer (optional)

When changing vacation type from "daily or half-daily" to "daily or hourly", this option allows to specify how many minutes is granted when someone has available half day

VacationDocumentPeriodType

Name

Type

Description

Name

Type

Description

DAILY

Enum

Vacation type for daily vacations

DAILY_OR_HALF_DAILY 

Enum

Vacation type for daily and half daily vacations

DAILY_OR_HOURLY

Enum

Vacation type for hourly vacations

Path
Body
Response

DELETE

Delete vacation type

Deletes vacation type.

Permissions: ADMIN USER SUPERVISOR HR

Responses: 204 404 500

Path params

Name

Type

Description

Name

Type

Description

vacationTypeId

int

Vacation type Id

Feel free to tell us what topic should be covered: vacationmanager@psc-software.atlassian.net