[REST 1.1] Vacation instances
POST
Add instance to existing recurring vacation definition
Creates new vacation instance for given vacation definition. Currently it works only for RECURRING vacation types, as for ONE_TIME can only have one instance that is already automatically created at vacation definition creation.
Permissions: ADMIN USER SUPERVISOR HR
POST {jira_baseurl}/rest/vacation-manager/1.0/vacation-instance?vacationDefinitionId=IDResponses: 200 404 500
Query params
Name | Type | Description |
|---|---|---|
vacationDefinitionId | Integer | Id of vacation definition. |
JSON body fields
Name | Type | Description |
|---|---|---|
entitledDays | Double | Integer value of entitled days to add. If vacation type is "Daily or half-daily", then you can also add half of the day to this value. |
GET
Get vacation instances for user
Returns all vacation instances for selected users.
Permissions: ADMIN USER SUPERVISOR HR
User can get vacation instances only for himself
Responses: 200 400 500
Path params:
Name | Type | Description |
|---|---|---|
userName | String | Name of user to get vacation instances |
Query params
Name | Type | Description |
|---|---|---|
startDate | String (optional) | Start date for instances. ISO 8601 format. |
endDate | String (optional) | End date for instances. ISO 8601 format. |
Get vacation instances by ID
Returns vacation instances
Permissions: ADMIN USER SUPERVISOR HR
Responses: 200 400 500
Path params:
Name | Type | Description |
|---|---|---|
vacationInstanceId | Int | Vacation instance ID |
PUT
Update existing vacation instance
Updates selected vacation instance.
Permissions: ADMIN USER SUPERVISOR HR
Responses: 200 400 500
Path params:
Name | Type | Description |
|---|---|---|
vacationInstanceId | Integer | Id of vacation definition |
JSON body fields:
Name | Type | Description |
|---|---|---|
startDate | String | New start date for instance. ISO 8601 format. Only for ONE_TIME instances. |
endDate | String | New end date for instance. ISO 8601 format. Only for ONE_TIME with hasEndDate instances. |
availableDays | Integer | New number of available days. If vacation type is "Daily or half-daily", then you can also add half of the day to this value. Only for hasDayLimit instances. |
availableMinutes | Integer | New number of available minutes. Only for "Daily or hourly" instances. |
entitledDays | Integer | New number of entitled days. If vacation type is "Daily or half-daily", then you can also add half of the day to this value. Only for hasDayLimit instances. |
carryOverDays | Integer | Number of carry over days. Only for hasCarryOverDays instances. |
carryOverMinutes | Integer | Number of carry over minutes. Only for hasCarryOverDays instances. |
Feel free to tell us what topic should be covered: vacationmanager@psc-software.atlassian.net