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

Example

Path

GET {jira_baseurl}/rest/vacation-manager/1.0/workweek-scheme

Response

[
  {
    "id": 1,
    "name": "Default workweek scheme",
    "workweekMinutes": {
      "TUESDAY": 480,
      "SUNDAY": 0,
      "MONDAY": 480,
      "WEDNESDAY": 480,
      "FRIDAY": 480,
      "THURSDAY": 480,
      "SATURDAY": 0
    },
    "type": "SEPARATE_WORK_MINUTES_FOR_EACH_DAY"
  },
  {
    "id": 2,
    "name": "Workweek scheme 2",
    "workweekMinutes": {
      "TUESDAY": 480,
      "SUNDAY": 0,
      "MONDAY": 480,
      "WEDNESDAY": 480,
      "FRIDAY": 480,
      "THURSDAY": 480,
      "SATURDAY": 0
    },
    "type": "SAME_WORK_MINUTES_FOR_ALL_DAYS"
  },
  {
    "id": 3,
    "name": "Workweek scheme 3",
    "workweekMinutes": {
      "TUESDAY": 480,
      "SUNDAY": 0,
      "MONDAY": 480,
      "WEDNESDAY": 400,
      "FRIDAY": 480,
      "THURSDAY": 400,
      "SATURDAY": 0
    },
    "type": "SEPARATE_WORK_MINUTES_FOR_EACH_DAY"
  }
]

Get single workweek scheme

Returns information about existing workweek scheme.

Permissions: ADMIN USER SUPERVISOR HR

GET {jira_baseurl}/rest/vacation-manager/1.0/workweek-scheme/{schemeId}

Responses: 200 400 500

Path param

Name	Type	Description
schemeId	int	Scheme ID

Example

Path

GET {jira_baseurl}/rest/vacation-manager/1.0/workweek-scheme/1

Response

{
  "id": 1,
  "name": "Default workweek scheme",
  "workweekMinutes": {
    "TUESDAY": 480,
    "SUNDAY": 0,
    "MONDAY": 480,
    "WEDNESDAY": 480,
    "FRIDAY": 480,
    "THURSDAY": 480,
    "SATURDAY": 0
  },
  "type": "SEPARATE_WORK_MINUTES_FOR_EACH_DAY"
}

Get workweek scheme for user

Returns workweek scheme used by given user.

Permissions: ADMIN USER SUPERVISOR HR

GET {jira_baseurl}/rest/vacation-manager/1.0/workweek-scheme?userName={userName}

Responses: 200 400 500

Query params

Name	Type	Description
userName	String	User Name

Example

Path

PATH{jira_baseurl}/rest/vacation-manager/1.0/workweek-scheme?userName=user1

Response

{
  "id": 1,
  "name": "Default workweek scheme",
  "workweekMinutes": {
    "TUESDAY": 480,
    "SUNDAY": 0,
    "MONDAY": 480,
    "WEDNESDAY": 480,
    "FRIDAY": 480,
    "THURSDAY": 480,
    "SATURDAY": 0
  },
  "type": "SEPARATE_WORK_MINUTES_FOR_EACH_DAY"
}

POST

Create new workweek scheme

Creates and returns new workweek scheme.

Permissions: ADMIN USER SUPERVISOR HR

Request /workweek-scheme

POST {jira_baseurl}/rest/vacation-manager/1.0/workweek-scheme

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

Example

Path

POST {jira_baseurl}/rest/vacation-manager/1.0/workweek-scheme

Body

{
  "name": "Workweek scheme name",
  "workweekMinutes": {
    "FRIDAY": 480,
    "MONDAY": 400,
    "WEDNESDAY": 800,
    "SUNDAY": 0,
    "TUESDAY": 480,
    "SATURDAY": 0,
    "THURSDAY": 400
  },
  "type": "SEPARATE_WORK_MINUTES_FOR_EACH_DAY"
}

Response

{
  "id": 101,
  "name": "Workweek scheme name",
  "workweekMinutes": {
    "TUESDAY": 480,
    "SUNDAY": 0,
    "MONDAY": 400,
    "WEDNESDAY": 800,
    "FRIDAY": 480,
    "THURSDAY": 400,
    "SATURDAY": 0
  },
  "type": "SEPARATE_WORK_MINUTES_FOR_EACH_DAY"
}

PATCH

Update workweek scheme

Update and return existing workweek scheme.

Permissions: ADMIN USER SUPERVISOR HR

PATCH {jira_baseurl}/rest/vacation-manager/1.0/workweek-scheme/{schemeId}

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

Example

Path

PATCH {jira_baseurl}/rest/vacation-manager/1.0/workweek-scheme/2

Body

 {
  "name": "Workweek scheme new name",
  "workweekMinutes": {
    "FRIDAY": 480,
    "MONDAY": 400,
    "WEDNESDAY": 800,
    "SUNDAY": 0,
    "TUESDAY": 480,
    "SATURDAY": 0,
    "THURSDAY": 400
  },
  "type": "SEPARATE_WORK_MINUTES_FOR_EACH_DAY"
}

Response

{
  "id": 2,
  "name": "Workweek scheme new name",
  "workweekMinutes": {
    "FRIDAY": 480,
    "MONDAY": 400,
    "WEDNESDAY": 800,
    "SUNDAY": 0,
    "TUESDAY": 480,
    "SATURDAY": 0,
    "THURSDAY": 400
  },
  "type": "SEPARATE_WORK_MINUTES_FOR_EACH_DAY"
}

PUT

Assign workweek scheme to users

Assigns workweek scheme to users.

Permissions: ADMIN USER SUPERVISOR HR

PUT {jira_baseurl}/rest/vacation-manager/1.0/vacman-user/workweek/bulk

Responses: 200 400 404 500

JSON body fields

Name	Type	Description
schemeId	Integer	Id of workweek scheme you want to assign to users
userNames	Array<String>	Names of users you want to assign workweek scheme to

Example

Path

PUT {jira_baseurl}/rest/vacation-manager/1.0/vacman-user/workweek/bulk

Body

{
   "schemeId": 1,
   "userNames": ["john", "jack"]
}

Response

{  
	"userNames": [
		"john", 
		"jack"
	],
   "schemeId": 1
}

DELETE

Delete workweek scheme

Deletes existing workweek scheme.

Permissions: ADMIN USER SUPERVISOR HR

DELETE {jira_baseurl}/rest/vacation-manager/1.0/workweek-scheme/{schemeId}

Responses: 204 404 500

Path params

Name	Type	Description
schemeId	int	Scheme ID

Example

Path

DELETE {jira_baseurl}/rest/vacation-manager/1.0/workweek-scheme/1

[REST 1.1] Workweek schemes

GET

Get workweek schemes list

Get single workweek scheme

Path param

Get workweek scheme for user

Query params

POST

Create new workweek scheme

Request /workweek-scheme

JSON body fields

DayOfWeek

WorkweekSchemeType

PATCH

Update workweek scheme

Path params

JSON body fields

DayOfWeek

WorkweekSchemeType

PUT

Assign workweek scheme to users

JSON body fields

DELETE

Delete workweek scheme

Path params