Overview
Vacation Manager's REST API provides holiday API which allows you to:
Methods:
GET
| Expand |
|---|
| title | Get holidays list from scheme |
|---|
|
Returns list of holidays assigned to given holiday scheme. Path| Code Block |
|---|
GET {jira_baseurl}/rest/vacation-manager/1.0/holiday-scheme/{schemeId}/holiday |
Permissions Path paramsName | Type | Description |
|---|
schemeId | int | scheme ID |
Response Example| Expand |
|---|
|
| Code Block |
|---|
| GET {jira_baseurl}/rest/vacation-manager/1.0/holiday-scheme/1/holiday |
| Code Block |
|---|
| [
{
"id": 1,
"date": "1970-12-25",
"yearly": true,
"description": "Christmas",
"holidaySchemeId": 1
},
{
"id": 2,
"date": "1970-01-01",
"yearly": true,
"description": "New year",
"holidaySchemeId": 1
}
] |
|
|
POST
| Anchor |
|---|
| createHoliday |
|---|
| createHoliday |
|---|
|
| Expand |
|---|
|
Returns and creates new holiday in holiday scheme. Path| Code Block |
|---|
POST {jira_baseurl}/rest/vacation-manager/1.0/holiday-scheme/{schemeId}/holiday |
Permissions Path paramsName | Type | Description |
|---|
schemeId | int | scheme ID |
JSON body fieldsName | Type | Description |
|---|
date | String | Holiday date. ISO 8601 format. | yearly | Boolean | true - holiday is repeated yearly, false - holiday occurs one time, on selected date | description | String | Holiday description |
Responses Example| Expand |
|---|
|
| Code Block |
|---|
| POST {jira_baseurl}/rest/vacation-manager/1.0/holiday-scheme/1/holiday |
| Code Block |
|---|
| {
"date": "2018-12-25",
"yearly": true,
"description": "Christmas"
} |
| Code Block |
|---|
| {
"id": 1,
"date": "2018-12-25",
"yearly": true,
"description": "Christmas",
"holidaySchemeId": 1
} |
|
|
PATCH
| Anchor |
|---|
| updateHoliday |
|---|
| updateHoliday |
|---|
|
| Expand |
|---|
|
Returns and Update existing holiday. Path| Code Block |
|---|
PATCH {jira_baseurl}/rest/vacation-manager/1.0/holiday-scheme/{schemeId}/holiday/{holidayId} |
Permissions Path paramsName | Type | Description |
|---|
schemeId | int | scheme ID | holidayId | int | holiday ID |
JSON body fieldsName | Type | Description |
|---|
date | String | Holiday date. ISO 8601 format. | yearly | Boolean | true - holiday is repeated yearly, false - holiday occurs one time, on selected date | description | String | Holiday description |
Responses Example| Expand |
|---|
|
| Code Block |
|---|
| PATCH {jira_baseurl}/rest/vacation-manager/1.0/holiday-scheme/1/holiday/1 |
| Code Block |
|---|
| {
"date": "2019-01-01",
"yearly": true,
"description": "New year"
} |
| Code Block |
|---|
| {
"id": 1,
"date": "2019-01-01",
"yearly": true,
"description": "New year",
"holidaySchemeId": 1
} |
|
|
DELETE
| Anchor |
|---|
| deleteHoliday |
|---|
| deleteHoliday |
|---|
|
| Expand |
|---|
| title | Delete holiday from scheme |
|---|
|
Deletes existing holiday. Path| Code Block |
|---|
DELETE {jira_baseurl}/rest/vacation-manager/1.0/holiday-scheme/{schemeId}/holiday/{holidayId} |
Permissions Path paramsName | Type | Description |
|---|
schemeId | int | scheme ID | holidayId | int | holiday ID |
Responses Example| Expand |
|---|
|
| Code Block |
|---|
| DELETE {jira_baseurl}/rest/vacation-manager/1.0/holiday-scheme/1/holiday/1 |
|
|
...