Versions Compared

Old Version 7

changes.mady.by.user Łukasz Modzelewski

Saved on

compared with

New Version 8

changes.mady.by.user Piotr Wasiak

Saved on

Key

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

...

Responses:

Status
colourGreen
title200
 
Status
colourYellow
title404
 
Status
colourRed
title500

Path params

Name

Type

Description

vacationTypeId

int

Vacation type Id

Expand
titleExample

Path

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

...

Responses:

Status
colourGreen
title200
 
Status
colourYellow
title404
 
Status
colourRed
title500

Path params

Name

Type

Description

vacationTypeId

int

Vacation type Id

Expand
titleExample
Path
Code Block
GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-type/1/update-info

Response

Code Block
{
  "anyInstanceHasAvailableHalfDay": false,
  "anyInstanceHasNonZeroAvailableMinutes": false
}

...

Response:

Status
colourGreen
title201
 
Status
colourYellow
title400
 
Status
colourRed
title500

JSON body fields

VacationType

Name

Type

Description

Name

Type

Description

project

Project

Project details object.

vacationType

VacationType

First Vacation Type details.

Project

...

Name

...

Type

...

Description

...

name

...

String

...

Name of a new project.

...

key

...

String

...

Key of a new project (all naming rules applies just like in other Jira projects).

...

description

...

String (Optional)

...

Description of a new project.

...

lead

...

String

...

Lead user name of a new project.

...

groupHr

...

String

...

Group name that will be assigned as HR group.

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.

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.

VacationDocumentPeriodType

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

ONE_TIME

Enum

Vacation kind type for one time vacations

RECURRING

Enum

Vacation kind  type for recurring vacations

PeriodDefinitionType

Name

Type

Description

MONTHS

Code Block
Enum

Type of monthly recurring 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"
}

...

Responses:

Status
colourGreen
title200
 
Status
colourYellow
title400
 
Status
colourYellow
title404
 
Status
colourRed
title500

Path params

Name

Type

Description

vacationTypeId

int

Vacation type Id

JSON body fields

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

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

Expand
titleExample
Path
Code Block
PUT {jira_baseurl}/rest/vacation-manager/1.0/vacation-type/1
Body
Code Block
{
  "vacationDocumentPeriodType":"DAILY"
}
Response
Code Block
{
  "id": 1,
  "name": "vacation type 1",
  "issueTypeId": "1",
  "vacationKindType": "ONE_TIME",
  "validThrough": false,
  "hasDayLimit": false,
  "carryOver": false,
  "description": "",
  "vacationDocumentPeriodType": "DAILY"
}

...

Responses:

Status
colourGreen
title204
 
Status
colourYellow
title404
 
Status
colourRed
title500

Path params

Name

Type

Description

vacationTypeId

int

Vacation type Id

Expand
titleExample
Path
Code Block
DELETE {jira_baseurl}/rest/vacation-manager/1.0/vacation-type/1