Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Overview

Vacation Manager's REST API provides team API which allows you to obtain:

Methods

GET

 Get vacation definition

Returns all vacation definitions for current user or only selected one vacation definition.

Path

GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/user/{userName}?vacationTypeId={vacationTypeId}

Permissions

ADMIN USER SUPERVISOR HR

Path params

NameTypeDescription
userNameStringUser name

Query params

NameTypeDescription
vacationTypeIdintVacation type Id

Responses

200 400 500

Example

 Example
Path
GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/userName
Response
[
  {
    "id": 1,
    "vacationTypeId": 1,
    "userId": "1",
	"userName": "userName",
    "vacationKindName": "vacation kind name 1",
    "startDate": "2018-10-18",
    "dayLimit": 0
  },
  {
    "id": 2,
    "vacationTypeId": 2,
	"userName": "userName",
    "vacationKindName": "vacation kind name 2",
    "startDate": "2018-10-30",
    "dayLimit": 23
  }
]
 Get vacation definition with given ID

Returns vacation definition with given ID

Path

GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/{vacationDefinitionId}

Permissions

ADMIN USER SUPERVISOR HR

Path params

NameTypeDescription
vacationDefinitionIdintVacation definition ID

Responses

200 400 500

Example

 Example
Path
GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/1
Response
[
  {
    "id": 1,
    "vacationTypeId": 1,
    "userId": 10000,
    "vacationTypeName": "remote",
    "startDate": "2021-02-01",
    "dayLimit": 0
}
]
 Get vacation definition with given ID

Returns list of vacation instances for given vacation definition,

Path

GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/{vacationDefinitionId}/vacation-instance

Permissions

ADMIN USER SUPERVISOR HR

Path params

NameTypeDescription
vacationDefinitionIdintVacation definition ID

Responses

200 400 500

Example

 Example
Path
GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/6/vacation-instance
Response
[
  {
    "id": 8,
    "startDate": "2021-01-01",
    "endDate": "2021-01-31",
    "availableDays": 5,
    "availableMinutes": 0,
    "entitledDays": 5,
    "carryOverDays": 0,
    "carryOverMinutes": 0,
    "usedDays": 0,
    "usedMinutes": 0,
    "vacationDocuments": [],
    "vacationDefinitionId": 6,
    "remainingCarryOverDays": 0,
    "remainingCarryOverMinutes": 0
  },
  {
    "id": 9,
    "startDate": "2021-02-01",
    "endDate": "2021-02-28",
    "availableDays": 10,
    "availableMinutes": 0,
    "entitledDays": 5,
    "carryOverDays": 5,
    "carryOverMinutes": 0,
    "usedDays": 0,
    "usedMinutes": 0,
    "vacationDocuments": [],
    "vacationDefinitionId": 6,
    "remainingCarryOverDays": 5,
    "remainingCarryOverMinutes": 0
  },
  {
    "id": 10,
    "startDate": "2021-03-01",
    "endDate": "2021-03-31",
    "availableDays": 5,
    "availableMinutes": 0,
    "entitledDays": 5,
    "carryOverDays": 0,
    "carryOverMinutes": 0,
    "usedDays": 0,
    "usedMinutes": 0,
    "vacationDocuments": [],
    "vacationDefinitionId": 6,
    "remainingCarryOverDays": 0,
    "remainingCarryOverMinutes": 0
  }
]


POST

 Create vacation definition

Creates and returns vacation definition.

Path

POST {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition

Permissions

ADMIN USER SUPERVISOR HR

JSON body fields

NameTypeDescription

vacationTypeId

Integer

vacation type id

userName

String

username to which dew vacation definition will be assigned

startDate

String

Date when user is enabled to request vacation using this definition.  ISO 8601 format.

endDate

String

Date when one time vacation type no longer enables user to request vacation using it. Must be used only when vacation has valid through option enabled.  ISO 8601 format.

dayLimit

Double

Default day limit. Should be integer when vacation is "daily only" or "daily or hourly". May contain additional half if vacation is "daily or half daily"

Responses

201 400 500

Example

 Example
Path
POST {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition
Body
{
  "vacationTypeId":"1",
  "userName": "userName",
  "startDate": "2018-09-10",
  "endDate": "2018-09-20",
  "dayLimit": 5
}
Response
{
  "id": 8,
  "vacationTypeId": 1,
  "userName": "userName",
  "vacationKindName": "Vacation kind name",
  "startDate": "2018-09-10",
  "endDate": "2018-09-20",
  "dayLimit": 5
}

PUT

 update vacation definition

Returns and updates vacation definition.

Path

PUT {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/{vacationDefinitionId}

Permissions

ADMIN USER SUPERVISOR HR

Path params

NameTypeDescription
vacationDefinitionIdintVacation definition ID

JSON body fields

NameTypeDescription
dayLimitdoubleDay limit

Responses

200 400 500

Example

 Example
Path
PUT {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/2
Body
{
    "dayLimit": 2
}
Response
{
  "id": 2,
  "vacationTypeId": 2,
  "userName": "userName",
  "vacationKindName": "vacation kind name 2",
  "startDate": "2018-10-30",
  "dayLimit": 2
}

DELETE

 Delete vacation definition

Deletes vacation definition.

Path

delete {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/{vacationDefinitionId}

Permissions

ADMIN USER SUPERVISOR HR

Path params

NameTypeDescription
vacationDefinitionIdintVacation definition ID

Responses

204 404 500

Example

 Example
Path
DELETE {jira_baseurl}/rest/vacation-manager/1.0/vacation-definition/1
  • No labels

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