[REST 1.1] Initial setup
- Marcin Wikarski (Unlicensed)
- Łukasz Modzelewski (Unlicensed)
- Tomasz Witkowski
Overview
Vacation Manager's REST API provides initial setup API which allows you to:
Methods:
POST
Create initial setup
Creates Vacation Manager project and first Vacation Type.
Permissions: ADMIN SUPERVISOR HR USER
POST {jira_baseurl}/rest/vacation-manager/1.0/initial-setupResponse: 201 400 500
JSON body fields
Name | Type | Description |
|---|---|---|
project | Project | Project details object. |
vacationTypeStepBean | VacationTypeStep | 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. |
VacationTypeSTEP
Name | Type | Description |
|---|---|---|
vacationTypeBean | VacationType | Vacation type details |
defaultValuesBean | DefaultVacationDefinition | Optional default vacation definition. Refer to default vacation definitions section for more details |
hasDefaultValues | boolean | Indicates if vacation type will have default vacation definition |
VacationType
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. |
DefaultVacationDefinition
Refer to create default vacation definition section for fields in this object.
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 | Enum | Type of monthly recurring period |
Feel free to tell us what topic should be covered: vacationmanager@psc-software.atlassian.net