[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 |
|---|
Name | Type | Description |
|---|---|---|
vacationDefinitionId | Integer | Id of vacation definition. |
JSON body fields
Name | Type | Description |
|---|
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. |
Path
POST {jira_baseurl}/rest/vacation-manager/1.0/vacation-instance?vacationDefinitionId=3Body
{
"entitledDays": "10"
}Response
{
"id": 9,
"startDate": "2020-05-01",
"endDate": "2021-04-30",
"availableDays": 10,
"availableMinutes": 0,
"entitledDays": 10,
"carryOverDays": 0,
"carryOverMinutes": 0,
"usedDays": 0,
"usedMinutes": 0,
"vacationDocuments": []
}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
GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-instance/user/{userName}?startDate=ISO_DATE&endDate=ISO_DATEResponses: 200 400 500
Path params:
Name | Type | Description |
|---|
Name | Type | Description |
|---|---|---|
userName | String | Name of user to get vacation instances |
Query params
Name | Type | Description |
|---|
Name | Type | Description |
|---|---|---|
startDate | String (optional) | Start date for instances. ISO 8601 format. |
endDate | String (optional) | End date for instances. ISO 8601 format. |
Path
GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-instance/user/admin?startDate=2018-01-01&endDate=2019-01-01Response
[
{
"id": 11,
"startDate": "2021-01-01",
"endDate": "2021-01-31",
"availableDays": 5,
"availableMinutes": 0,
"entitledDays": 5,
"carryOverDays": 0,
"carryOverMinutes": 0,
"usedDays": 0,
"usedMinutes": 0,
"vacationDocuments": [],
"vacationDefinitionId": 7,
"remainingCarryOverDays": 0,
"remainingCarryOverMinutes": 0
}
]Get vacation instances by ID
Returns vacation instances
Permissions: ADMIN USER SUPERVISOR HR
GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-instance/{vacationInstanceId}Responses: 200 400 500
Path params:
Name | Type | Description |
|---|
Name | Type | Description |
|---|---|---|
vacationInstanceId | Int | Vacation instance ID |
Path
GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-instance/1Response
[
{
"id": 1,
"startDate": "2021-02-01",
"endDate": "3000-01-01",
"availableDays": 0,
"availableMinutes": 0,
"entitledDays": 0,
"carryOverDays": 0,
"carryOverMinutes": 0,
"usedDays": 0,
"usedMinutes": 0,
"vacationDocuments": [],
"vacationDefinitionId": 1,
"remainingCarryOverDays": 0,
"remainingCarryOverMinutes": 0
}
]PUT
Update existing vacation instance
Updates selected vacation instance.
Permissions: ADMIN USER SUPERVISOR HR
PUT {jira_baseurl}/rest/vacation-manager/1.0/vacation-instance/{vacationInstanceId}Responses: 200 400 500
Path params:
Name | Type | Description |
|---|
Name | Type | Description |
|---|---|---|
vacationInstanceId | Integer | Id of vacation definition |
JSON body fields:
Name | Type | Description |
|---|
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. |
Path
PUT {jira_baseurl}/rest/vacation-manager/1.0/vacation-instance/10Body
{
"startDate": "2018-01-01",
"endDate": "2018-01-03",
"availableDays": 10,
"entitledDays": 20
}Response
{
"id": 10,
"startDate": "2018-01-01",
"endDate": "2018-01-03",
"availableDays": 10,
"entitledDays": 20,
"carryOverDays": 0,
"carryOverMinutes": 0,
"usedDays": 0,
"usedMinutes": 0,
"vacationDocuments": []
}