[REST 1.1] Configuration
Methods:
POST
Triggers recalculation of recurring vacations.
Permissions: ADMIN USER SUPERVISOR HR
POST {jira_baseurl}/rest/vacation-manager/1.0/configuration/refresh-recurring-vacation-definitions
PUT
Update general config
Updates and returns general configuration.
Permissions: ADMIN USER SUPERVISOR HR
PUT {jira_baseurl}/rest/vacation-manager/1.0/configuration/general
Responses: 200 400 500
JSON body fields
Name | Type | Description |
---|---|---|
automaticSummary | Boolean | true - summary for new vacation documents will be filled automatically false - users will have to provide summary for vacation documents |
automaticSummaryTexts | Automatic summary texts that will be used to fill summary for new vacation documents. Each request period type has to have corresponding summary text | |
jobTime | Number representing full hour to run job recalculating recurring vacation (job is run everyday) | |
showUserPickerWarning | true - show warning near user picker fields when user is currently out on vacation or will be in near future false - hide warning | |
userPickerTexts | User picker warning texts that show up when user is on vacation or when user vacation is near. | |
daysBeforeLeaveWarning | Number of days before user leave that user picker warning about upcoming absence will be visible | |
allowUsersToViewStatistics | true - users will be able to view their teammates vacations false - users will be able to view only their vacations | |
worklogHoursPerDayType | JIRA_TIMETRACKING - hours per day for worklog will be fetched from default Jira worklog timetracking configuration VACMAN_WORKWEEK_SCHEME - hours per day will be fetched from Vacation Manager workweek scheme for given user |
PeriodType
Name | Type | Description |
---|---|---|
DAILY | Enum | Daily period type |
HALF_DAILY | Enum | Half daily period type |
HOURLY | Enum | Hourly period type |
WorklogHoursPerDayType
Name | Type | Description |
---|---|---|
JIRA_TIMETRACKING | Enum | Hours per day for worklog will be fetched from default Jira worklog timetracking configuration |
VACMAN_WORKWEEK_SCHEME | Enum | Hours per day will be fetched from Vacation Manager workweek scheme for given user |
UserPickerLeaveMessageType
Name | Type | Description |
---|---|---|
VACATION_ON_LEAVE | Enum | Message type when user is currently on vacations |
VACATION_UPCOMING_LEAVE | Enum | Message type when user vacation are near |
HOLIDAY_ON_LEAVE | Enum | Message type when currently is holiday |
HOLIDAY_UPCOMING_LEAVE | Enum | Message type when holiday is near |
Update groups configuration
Permissions: ADMIN USER SUPERVISOR
Responses: 204 400 500
JSON body fields
Name | Type | Description |
---|---|---|
hrGroupName | Name of Jira group that will be used as HR in VacMan | |
createSchemes | true - creates and assigns new Security and Permission Schemes for Vacation Manager project. Old schemes will be left intact false - no new schemes are created |
Update fields configuration.
Permissions: ADMIN USER SUPERVISOR HR
Responses: 204 400 500
JSON body fields
Name | Type | Description |
---|---|---|
chartCustomFieldId | Id of custom field to set as chart | |
periodTypeCustomFieldId | Id of custom field to set as period type | |
startDateCustomFieldId | Id of custom field to set as start date | |
startDateTimeCustomFieldId | Id of custom field to set as start date time | |
endDateCustomFieldId | Id of custom field to set as end date | |
endTimeMinutesCustomFieldId | Id of custom field to set as time period picker | |
halfDayCustomFieldId | Id of custom field to set as half of day | |
supervisorCustomFieldId | Id of custom field to set as supervisor | |
substituteCustomFieldId | Id of custom field to set as substitute person | |
usedVacationDaysCustomFieldId | Id of custom field to set as used vacation days | |
usedVacationMinutesCustomFieldId | Id of custom field to set as used vacation minutes | |
migrateData | true - copies data from old to new fields in all vacation documents false - no data is copied |
DELETE
Deletes configuration.
Permissions: ADMIN USER SUPERVISOR HR
Responses 204 500
GET
Returns whole configuration.
Permissions: ADMIN USER SUPERVISOR HR
Responses: 200 500
Returns general configuration.
Permissions: ADMIN USER SUPERVISOR HR
Responses: 200 500
Returns groups configuration.
Permissions: ADMIN USER SUPERVISOR HR
Responses: 200 500
Returns fields configuration.
Permissions: ADMIN USER SUPERVISOR HR
Responses: 200 500
Feel free to tell us what topic should be covered: vacationmanager@psc-software.atlassian.net