Returns list of vacation documents available to logged user
Permissions:
GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-document?teamId={teamId} |
Responses:
Name | Type | Description |
---|---|---|
teamId | Integer | Team ID |
reporter | String | Name of reporter of vacation document |
supervisor | String | Name of supervisor assigned to vacation document |
startDate | String | Date that vacation have to start after. ISO 8601 format. |
endDate | String | Date that vacation have to end before. ISO 8601 format. |
periodStartDate | String | The start date of the vacation period for which we want a vacation list. ISO 8601 format. |
periodEndDate | String | The end date of the vacation period for which we want a vacation list. ISO 8601 format. When you set the periodStartDate and periodEndDate, you will search for vacation documents started/ongoing/ended during that period. |
Path
Response
|
Returns information about existing vacation document.
Permissions:
GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-document/{issueKey} |
Responses:
Name | Type | Description |
---|---|---|
issueKey | String | Issue key |
Request
Response
|
Returns vacation documents waiting for approval
Permissions:
GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-document/waiting-for-approval?reporter={reporter}&supervisor={supervisor}&startDate={startDate}&endDate={endDate} |
Responses:
Name | Type | Description |
---|---|---|
reporter | String | Name of reporter of vacation document |
supervisor | String | Name of supervisor assigned to vacation document |
startDate | String | Date that vacation have to start after. ISO 8601 format. |
endDate | String | Date that vacation have to end before. ISO 8601 format. |
Path
Response
|
Returns available actions that could be executed upon vacation document.
Permissions:
GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-document/{issueKey}/actions |
Responses:
Name | Type | Description |
---|---|---|
issueKey | String | Issue key |
Path
Response
|
Create and returns new vacation document. It creates new Jira issue.
Permissions:
POST {jira_baseurl}/rest/vacation-manager/1.0/vacation-document |
Responses:
Name | Type | Description | |
---|---|---|---|
reporterName | String | Reporter name | |
supervisorName | String | Supervisor name | |
substituteName | String (Optional) | Substitute name | |
description | String (Optional) | Description for created issue | |
vacationKindId | Integer | Vacation document is created for vacation kind with this id | |
periodType | PeriodType | Period type | |
startDate |
| Start date of the leave for daily and half-daily requests. ISO 8601 format. | |
startDateTime |
| Start date time of the leave for hourly requests. ISO 8601 format. | |
endDate |
| End date of the leave for daily requests. ISO 8601 format. | |
halfDayType |
| Required for half-daily requests. | |
endTimeMinutes |
| Duration of hourly leave in minutes. Required for hourly request |
Name | Type | Description |
---|---|---|
DAILY | Enum | Daily peroid type |
HALF_DAILY | Enum | Half daily period type |
HOURLY | Enum | Hourly period type |
Name | Type | Description |
---|---|---|
AM | Enum | First half of work day |
PM | Enum | Second half of work day |
Path
Body
Response
|
Updates existing vacation document.
Permissions:
PUT {jira_baseurl}/rest/vacation-manager/1.0/vacation-document |
Responses:
Name | Type | Description | |
---|---|---|---|
reporterName | String | Reporter name | |
supervisorName | String | Supervisor name | |
substituteName | String (Optional) | Substitute name | |
description | String (Optional) | Description for created issue | |
vacationKindId | Integer | Vacation document is created for vacation kind with this id | |
periodType | PeriodType | Period type | |
startDate |
| Start date of the leave for daily and half-daily requests. ISO 8601 format. | |
startDateTime |
| Start date time of the leave for hourly requests. ISO 8601 format. | |
endDate |
| End date of the leave for daily requests. ISO 8601 format. | |
halfDayType |
| Required for half-daily requests. | |
endTimeMinutes |
| Duration of hourly leave in minutes. Required for hourly request |
Name | Type | Description |
---|---|---|
DAILY | Enum | Daily peroid type |
HALF_DAILY | Enum | Half daily period type |
HOURLY | Enum | Hourly period type |
Name | Type | Description |
---|---|---|
AM | Enum | First half of work day |
PM | Enum | Second half of work day |
Path
Body
|
Updates status of vacation document.
Permissions:
PUT {jira_baseurl}/rest/vacation-manager/1.0/vacation-document/status |
Responses:
Name | Type | Description |
---|---|---|
issueKey | String | Key of issue to update status |
actionId | Integer | Id of action to execute on issue in order to make transition. To retrieve available actions, see get actions |
comment | String (optional) | Comment to add upon changing status. Some actions require comments |
Path
Body
|