Versions Compared

Key

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

...

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

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.

...

Name

Type

Description

MONTHS

Code Block
Enum

Type of monthly recurring period

CarryoverClearPeriodDefinition

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

DAYS

Code Block
Enum

Type of daily carryover days clear period.

Expand
titleExample

Path

Code Block
POST {jira_baseurl}/rest/vacation-manager/1.0/vacation-type
Body
Code Block
{
    "name": "Vacation type name",
    "kindType": "ONE_TIME",
    "hasEndDate": false,
    "hasDayLimit": false,
	"vacationDocumentPeriodType": "DAILY",
	"useWorklog": false
}
Response 
Code Block
{
    "id": 2,
    "name": "Vacation type name",
    "issueTypeId": "10101",
    "kindType": "ONE_TIME",
    "periodDefinition": {},
    "hasEndDate": false,
    "hasDayLimit": false,
    "hasCarryOver": false,
	"useWorklog": false,
    "vacationDocumentPeriodType": "DAILY"
}

...