[REST 1.1] Holiday schemes

GET

Get holiday schemes list

Returns list of holiday schemes.

Permissions: ADMIN USER SUPERVISOR HR

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

Responses: 200 500

Path
GET {jira_baseurl}/rest/vacation-manager/1.0/holiday-scheme
Response
[ { "id": 1, "name": "Default holiday scheme" }, { "id": 2, "name": "Holiday scheme 1" }, { "id": 3, "name": "Holiday scheme 2" } ]

Get holiday scheme for user

Returns holiday scheme used by given user.

Permissions: ADMIN USER SUPERVISOR HR

Responses: 200   500

Query params

Name

Type

Description

Name

Type

Description

userName

string

User name

Path

Response


POST 

Create holiday scheme

Creates and return new holiday scheme.

Permissions: ADMIN USER SUPERVISOR HR

Responses: 201 400 500

JSON body fields

Name

Type

Description

Name

Type

Description

name

String

Holiday scheme name, must be unique for each scheme

Path
Body

Response


PATCH

Update holiday scheme

Updates and return existing holiday scheme.

Permissions: ADMIN USER SUPERVISOR HR

Responses: 200 400 404 500

Path params

Name

Type

Description

Name

Type

Description

schemeId

int

Holiday scheme ID

JSON body fields

Name

Type

Description

Name

Type

Description

name

String

Holiday scheme new name

Path

Body

Response

PUT

Assign holiday scheme to users

Assigns holiday scheme to users.

Permissions: ADMIN USER SUPERVISOR HR

Responses: 200 400 404 500

JSON body fields

Name

Type

Description

Name

Type

Description

schemeId

Id of holiday scheme you want to assign to users 

userNames

Names of users you want to assign holiday scheme to

Path
Body
Response

DELETE

Delete holiday scheme

Deletes existing holiday scheme.

Permissions: ADMIN USER SUPERVISOR HR

Responses: 204  404 500

Path params

Name

Type

Description

Name

Type

Description

schemeId

Id of holiday scheme you want to assign to users 

Feel free to tell us what topic should be covered: vacationmanager@psc-software.atlassian.net