Versions Compared

Key

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

...

Name

Type

Description

id

int

Object Id

vacationTypeId

int

Vacation Type Id

daysCountLimit

double

Number of days that will be assigned to user

defaultPeriodType

VacationTypeDefaultPeriodType

One of values:

  • ONE_TIME_DYNAMIC_DAYS_OFFSET

  • ONE_TIME_FIXED_DAYS_OFFSET

  • RECURRING_PERIOD_OFFSET

  • RECURRING_DYNAMIC_OFFSET

  • RECURRING_FIXED_OFFSET

dynamicOffset

String

Start date offset of vacation days after user is added to Vacation Manager, 1m 1w 1d format

(required for DYNAMIC defaultPeriodType)

dynamicDays

int

End date offset from dynamicOffset

(required for DYNAMIC defaultPeriodType)

fixedStartDate

String

Start date of vacation days, YYYY-MM-DD format

(required for FIXED defaultPeriodType)

fixedEndDate

String

End date of vacation days, YYYY-MM-DD format

(required for FIXED defaultPeriodType)

periodOffset

int

Start date offset in periods for new vacation days.

0 - current period

-1, -2... - previous periods

1, 2... - next periods

(required for PERIOD defaultPeriodType)

Expand
titleExample
Path
title
Code Block
Path
POST {jira_baseurl}/rest/vacation-manager/1.0/default-vacation-definition
Body
Code Block
titleBody
{
  "vacationTypeId": 2,
  "daysCountLimit": 20,
  "defaultPeriodType": "RECURRING_PERIOD_OFFSET",
  "periodOffset": 2
}
Response
Response
Code Block
title
{
  "id": 2,
  "vacationTypeId": 2,
  "daysCountLimit": 20.0,
  "defaultPeriodType": "RECURRING_PERIOD_OFFSET",
  "periodOffset": 2
}

...

Responses:

Status
colourGreen
title200
 
Status
colourRed
title500

Expand
titleExample
Path
Path
Code Block
title
GET {jira_baseurl}/rest/vacation-manager/1.0/default-vacation-definition
Response
Code Block
titleResponse
[
    {
        "id": 1,
        "vacationTypeId": 1,
        "daysCountLimit": 1.0,
        "defaultPeriodType": "ONE_TIME_DYNAMIC_DAYS_OFFSET",
        "dynamicOffset": "1",
        "dynamicDays": 1
    },
    {
        "id": 2,
        "vacationTypeId": 2,
        "daysCountLimit": 20.0,
        "defaultPeriodType": "RECURRING_PERIOD_OFFSET",
        "periodOffset": 2
    }
]

...

Name

Type

Description

defaultVacationDefinitionId

int

Id of default vacation definition object

Expand
titleExample
Path
Code Block
titlePath
GET {jira_baseurl}/rest/vacation-manager/1.0/default-vacation-definition/1
Response
Response
Code Block
title
{
    "id": 1,
    "vacationTypeId": 1,
    "daysCountLimit": 1.0,
    "defaultPeriodType": "ONE_TIME_DYNAMIC_DAYS_OFFSET",
    "dynamicOffset": "1",
    "dynamicDays": 1
}

...

Name

Type

Description

vacationTypeId

int

Id of vacation type

Expand
titleExample
Path
title
Code Block
Path
GET {jira_baseurl}/rest/vacation-manager/1.0/default-vacation-definition/vacation-type/1
Response
Code Block
titleResponse
[
    {
        "id": 1,
        "vacationTypeId": 1,
        "daysCountLimit": 1.0,
        "defaultPeriodType": "ONE_TIME_DYNAMIC_DAYS_OFFSET",
        "dynamicOffset": "1",
        "dynamicDays": 1
    }
]

...

JSON body fields

Same as in create default values endpoint.

Expand
titleExample
Path
Path
Code Block
title
PUT {jira_baseurl}/rest/vacation-manager/1.0/default-vacation-definition/2
Body
Body
Code Block
title
{
  "vacationTypeId": 2,
  "daysCountLimit": 25,
  "defaultPeriodType": "RECURRING_PERIOD_OFFSET",
  "periodOffset": 2
}
Response
Code Block
titleResponse
{
    "id": 2,
    "vacationTypeId": 2,
    "daysCountLimit": 25.0,
    "defaultPeriodType": "RECURRING_PERIOD_OFFSET",
    "periodOffset": 2
}

...

Name

Type

Description

defaultVacationDefinitionId

int

Id of default values object

Expand
titleExample
Path
Code Block
titlePath
DELETE {jira_baseurl}/rest/vacation-manager/1.0/default-vacation-definition/3

...

Name

Type

Description

vacationTypeId

int

Id of vacation type object to delete default values object from

Expand
titleExample
Path
Path
Code Block
title
DELETE {jira_baseurl}/rest/vacation-manager/1.0/default-vacation-definition/vacation-type/5

...