[REST 1.1] Workweek schemes
GET
Get workweek schemes list
Returns list of workweek schemes.
Permissions: ADMIN USER SUPERVISOR HR
GET {jira_baseurl}/rest/vacation-manager/1.0/workweek-scheme
Responses: 200 400 500
Get single workweek scheme
Returns information about existing workweek scheme.
Permissions: ADMIN USER SUPERVISOR HR
Responses: 200 400 500
Path param
Name | Type | Description |
---|---|---|
schemeId | int | Scheme ID |
Get workweek scheme for user
Returns workweek scheme used by given user.
Permissions: ADMIN USER SUPERVISOR HR
Responses: 200 400 500
Query params
Name | Type | Description |
---|---|---|
userName | String | User Name |
POST
Create new workweek scheme
Creates and returns new workweek scheme.
Permissions: ADMIN USER SUPERVISOR HR
Responses: 201 400 500
JSON body fields
Name | Type | Description |
---|---|---|
name | String | Workweek scheme name |
workweekMinutes | Map<DayOfWeek, Integer> | Day of week : working time in minutes |
type | WorkweekSchemeType | Type of work week scheme |
DayOfWeek
Name | Type | Description |
---|---|---|
MONDAY | Enum | Monday |
TUESDAY | Enum | Tuesday |
WEDNESDAY | Enum | Wednesday |
THURSDAY | Enum | Thursday |
FRIDAY | Enum | Friday |
SATURDAY | Enum | Saturday |
SUNDAY | Enum | Sunday |
WorkweekSchemeType
Name | Type | Description |
---|---|---|
SAME_WORK_MINUTES_FOR_ALL_DAYS | Enum | Type of the same work minutes for all days |
SEPARATE_WORK_MINUTES_FOR_EACH_DAY | Enum | Type of separate work minutes for each day |
PATCH
Update workweek scheme
Update and return existing workweek scheme.
Permissions: ADMIN USER SUPERVISOR HR
Responses: 200 400 404 500
Path params
Name | Type | Description |
---|---|---|
schemeId | int | Scheme ID |
JSON body fields
Name | Type | Description |
---|---|---|
name | String | Workweek scheme name |
workweekMinutes | Map<DayOfWeek, Integer> | Day of week : working time in minutes |
type | WorkweekSchemeType | Type of work week scheme |
DayOfWeek
Name | Type | Description |
---|---|---|
MONDAY | Enum | Monday |
TUESDAY | Enum | Tuesday |
WEDNESDAY | Enum | Wednesday |
THURSDAY | Enum | Thursday |
FRIDAY | Enum | Friday |
SATURDAY | Enum | Saturday |
SUNDAY | Enum | Sunday |
WorkweekSchemeType
Name | Type | Description |
---|---|---|
SAME_WORK_MINUTES_FOR_ALL_DAYS | Enum | Type of the same work minutes for all days |
SEPARATE_WORK_MINUTES_FOR_EACH_DAY | Enum | Type of separate work minutes for each day |
PUT
Assign workweek scheme to users
Assigns workweek scheme to users.
Permissions: ADMIN USER SUPERVISOR HR
Responses: 200 400 404 500
JSON body fields
Name | Type | Description |
---|---|---|
schemeId | Id of workweek scheme you want to assign to users | |
userNames | Names of users you want to assign workweek scheme to |
DELETE
Delete workweek scheme
Deletes existing workweek scheme.
Permissions: ADMIN USER SUPERVISOR HR
Responses: 204 404 500
Path params
Name | Type | Description |
---|---|---|
schemeId | int | Scheme ID |
Feel free to tell us what topic should be covered: vacationmanager@psc-software.atlassian.net