[REST 1.1] Paths for Vacation Manager REST API
- Marcin Wikarski (Unlicensed)
- Damian Karbownik (Unlicensed)
- Tomasz Witkowski
Postman rest collection
For your convenience we prepared Postman collection, so you can easily test Vacation Manager REST API on your environment.
Vacation Manager REST API 1.1.postman_collection.json
Variables:
{{baseurl}} - path to your Jira,
{{username}} - name of Jira user that will execute REST queries,
{{userpassword}} - password for that user.
Paths
{jira_baseurl}/vacation-manager/1.0
Name | REST type | Description | Permissions |
|---|---|---|---|
Teams | |||
/team | POST | create team | ADMIN, HR |
/team/{teamId}/member | POST | add member | ADMIN, HR |
/team | GET | get all teams | ADMIN, HR |
/team/{teamId} | GET | get team info (users) | ADMIN, HR |
/tem/{teamId}/member | GET | get team info (members) | ADMIN, HR |
/team/{teamId} | PATCH | update team | ADMIN, HR |
/team/{teamId} | DELETE | delete team | ADMIN, HR |
/team/{teamId}/member | DELETE | delete team member | ADMIN, HR |
Vacation types | |||
/vacation-type | POST | create vacation type | ADMIN |
/vacation-type | GET | get all vacation types | ALL |
/vacation-type/{vacationTypeId} | GET | get vacation type info | ALL |
/vacation-type/{vacationTypeId}/update-info | GET | get vacation type update info | ALL |
/vacation-type/{vacationTypeId} | PUT | update vacation type | ADMIN |
/vacation-type/{vacationTypeId} | DELETE | delete vacation type | ADMIN |
Holiday schemes | |||
/holiday-scheme | POST | create holiday scheme | ADMIN, HR |
/holiday-scheme | GET | get all holiday schemes | ADMIN, HR |
/holiday-scheme/user/{userName} | GET | get holiday scheme for user | ADMIN, HR |
/holiday-scheme/{holidaySchemeId} | PATCH | update holiday scheme | ADMIN, HR |
/holiday-scheme/{holidaySchemeId} | DELETE | delete holiday scheme | ADMIN, HR |
/vacmanuser/holiday/bulk | PUT | assign holiday scheme | ADMIN, HR |
Holidays | |||
/holiday-scheme/{holidayschemeId}/holiday | POST | create holiday | ADMIN, HR |
/holiday-scheme/{holidayschemeId}/holiday | GET | get holidays from scheme | ADMIN, HR |
/holiday-scheme/{holidayschemeId}/holiday/{holidayId} | PUT | update holiday | ADMIN, HR |
/holiday-scheme/{holidayschemeId}/holiday/{holidayId} | DELETE | delete holiday | ADMIN, HR |
Vacation definitions | |||
/vacation-definition | POST | add vacation definition | ADMIN, HR |
/vacation-definition/recurring | PUT | update recurring vacation definition | ADMIN, HR |
/vacation-definition/user/{userName} | GET | get vacation definition for user | ADMIN, HR |
/vacation-definition/{vacationDefinitionId} | GET | get vacation definition with given ID | ADMIN, HR |
/vacation-definition/{vacationDefinitionId}/vacation-instance | GET | get list of vacation instances for given vacation definition | ADMIN, HR |
Vacation documents | |||
/vacation-document | POST | create new vacation document | ALL |
/vacation-document | PUT | update vacation document | ALL |
/vacation-document/status | PUT | update status of vacation document | ALL |
/vacation-document | GET | get vacation documents list | ALL |
/vacation-document//{issueKey} | GET | get single vacation document by issue key | ALL |
/vacation-document/waiting-for-approval | GET | get vacation documents waiting for approval | ALL |
/vacation-document/issueKey/actions | GET | get actions available for vacation document | ALL |
Initial setup | |||
/initial-setup | POST | create initial setup | ADMIN |
Statistics | |||
/statistics/user | GET | get instances statistics by logged user | ALL |
/statistics/user/{userName} | GET | get instances statistics by user | ADMIN, HR |
/statistics/vacation-type/{vacationTypeId} | GET | get instances statistics by vacation type | ADMIN, HR |
Workweek schemes | |||
/workweek-scheme | GET | get workweek schemes list | ADMIN, HR |
/workweek-scheme/{schemeId} | GET | get single workweek scheme | ADMIN, HR |
/workweek-scheme?userName={userName} | GET | get workweek scheme for user | ADMIN, HR |
/workweek-scheme | POST | create workweek scheme | ADMIN, HR |
/workweek-scheme/{schemeId} | PATCH | update workweek scheme | ADMIN, HR |
/workweek-scheme/{schemeId} | DELETE | delete Workweek Scheme | ADMIN, HR |
Vacation instances | |||
/vacation-instance/user/{userName}?startDate=ISO_DATE&endDate=ISO_DATE | GET | get vacation instances for user | ADMIN, HR |
/vacation-instance/{vacationInstanceId} | GET | get vacation instance with given ID | ADMIN, HR |
/vacation-instance?vacationDefinitionId=ID | POST | add instance to existing recurring vacation definition | ADMIN, USER, HR |
/vacation-instance/{vacationInstanceId} | PUT | update existing vacation instance | ADMIN, HR |
Configuration | |||
/configuration | GET | get whole configuration | ADMIN |
/configuration/general | GET | get general configuration | ADMIN |
/configuration/groups | GET | get groups configuration | ADMIN |
/configuration/fields | GET | get fields configuration | ADMIN |
/configuration/refresh-recurring-vacation-definitions | POST | recalculate recurring vacations | ADMIN |
/configuration/general | PUT | update general configuration | ADMIN |
/configuration/groups | PUT | update groups configuration | ADMIN |
/configuration/fields | PUT | update fields configuration | ADMIN |
/configuration | DELETE | delete configuration | ADMIN |
Default vacation definitions | |||
/default-vacation-definition | POST | create default vacation definition | ADMIN |
/default-vacation-definition | GET | get all default vacation definitions | ADMIN |
/default-vacation-definition | GET | get default vacation definition by Id | ADMIN |
/default-vacation-definition/ | GET | get default vacation definition by vacation type Id | ADMIN |
/default-vacation-definition | PUT | update default vacation definition | ADMIN |
/default-vacation-definition | DELETE | delete default vacation definition by Id | ADMIN |
/default-vacation-definition | DELETE | delete default vacation definition by vacation type Id | ADMIN |
Feel free to tell us what topic should be covered: vacationmanager@psc-software.atlassian.net