You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 2
Next »
Overview
Each vacation type could have defined default vacation definitions - automatically assigned vacation days for new users.
Methods
POST
Create default vacation definition
Creates default vacation definition for vacation type.
Path
POST {jira_baseurl}/rest/vacation-manager/1.0/default-vacation-definition
Permissions
ADMIN USER SUPERVISOR HR
JSON body fields
| 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) |
Responses
201 404 500
Example
Example
POST {jira_baseurl}/rest/vacation-manager/1.0/default-vacation-definition
{
"vacationTypeId": 2,
"daysCountLimit": 20,
"defaultPeriodType": "RECURRING_PERIOD_OFFSET",
"periodOffset": 2
}
{
"id": 2,
"vacationTypeId": 2,
"daysCountLimit": 20.0,
"defaultPeriodType": "RECURRING_PERIOD_OFFSET",
"periodOffset": 2
}
GET
Get all default vacation definitions
Returns list of all default vacation definitions.
Path
GET {jira_baseurl}/rest/vacation-manager/1.0/default-vacation-definition
Permissions
ADMIN USER SUPERVISOR HR
Responses
200 500
Example
Example
GET {jira_baseurl}/rest/vacation-manager/1.0/default-vacation-definition
[
{
"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
}
]
Get default vacation definition object by Id
Returns default vacation definition object by its Id.
Path
GET {jira_baseurl}/rest/vacation-manager/1.0/default-vacation-definition/{defaultVacationDefinitionId}
Permissions
ADMIN USER SUPERVISOR HR
Path params
| Name | Type | Description |
|---|
| defaultVacationDefinitionId | int | Id of default vacation definition object |
Responses
200 404 500
Example
Example
GET {jira_baseurl}/rest/vacation-manager/1.0/default-vacation-definition/1
{
"id": 1,
"vacationTypeId": 1,
"daysCountLimit": 1.0,
"defaultPeriodType": "ONE_TIME_DYNAMIC_DAYS_OFFSET",
"dynamicOffset": "1",
"dynamicDays": 1
}
Get default vacation defintion object by Vacation Type
Returns default vacation definition object by Vacation Type that it's assigned to.
Path
GET {jira_baseurl}/rest/vacation-manager/1.0/default-vacation-definition/vacation-type/{vacationTypeId}
Permissions
ADMIN USER SUPERVISOR HR
Path params
| Name | Type | Description |
|---|
| vacationTypeId | int | Id of vacation type |
Responses
200 404 500
Example
Example
GET {jira_baseurl}/rest/vacation-manager/1.0/default-vacation-definition/vacation-type/1
[
{
"id": 1,
"vacationTypeId": 1,
"daysCountLimit": 1.0,
"defaultPeriodType": "ONE_TIME_DYNAMIC_DAYS_OFFSET",
"dynamicOffset": "1",
"dynamicDays": 1
}
]
PUT
Update default vacation definition
Updates and returns default vacation definition object.
Path
PUT {jira_baseurl}/rest/vacation-manager/1.0/default-vacation-definition/{defaultVacationDefinitionId}
Permissions
ADMIN USER SUPERVISOR HR
Path params
| Name | Type | Description |
|---|
| defaultVacationDefinitionId | int | Id of default values object to update |
JSON body fields
Same as in create default values endpoint.
Responses
200 400 404 500
Example
Example
PUT {jira_baseurl}/rest/vacation-manager/1.0/default-vacation-definition/2
{
"vacationTypeId": 2,
"daysCountLimit": 25,
"defaultPeriodType": "RECURRING_PERIOD_OFFSET",
"periodOffset": 2
}
{
"id": 2,
"vacationTypeId": 2,
"daysCountLimit": 25.0,
"defaultPeriodType": "RECURRING_PERIOD_OFFSET",
"periodOffset": 2
}
DELETE
Delete default vacation defintion object by Id
Deletes default vacation definition object.
Path
DELETE {jira_baseurl}/rest/vacation-manager/1.0/default-vacation-definition/{defaultVacationDefinitionId}
Permissions
ADMIN USER SUPERVISOR HR
Path params
| Name | Type | Description |
|---|
| defaultVacationDefinitionId | int | Id of default values object |
Responses
204 404 500
Example
DELETE {jira_baseurl}/rest/vacation-manager/1.0/default-vacation-definition/3
Delete default vacation definition object for vacation type
Deletes default values object for given vacation type.
Path
DELETE {jira_baseurl}/rest/vacation-manager/1.0/default-vacation-definition/vacation-type/{vacationTypeId}
Permissions
ADMIN USER SUPERVISOR HR
Path params
| Name | Type | Description |
|---|
| vacationTypeId | int | Id of vacation type object to delete default values object from |
Responses
204 404 500
Example
DELETE {jira_baseurl}/rest/vacation-manager/1.0/default-vacation-definition/vacation-type/5