Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name

Type

Description

teamId

Integer

Team ID

reporter

String

Name of reporter of vacation document

supervisor

String

Name of supervisor assigned to vacation document

startDate

String

Date that vacation have to start after. ISO 8601 format.

endDate

String

Date that vacation have to end before. ISO 8601 format.

periodStartDate

String

The start date of the vacation period for which we want a vacation list.

ISO 8601 format.

periodEndDate

String

The end date of the vacation period for which we want a vacation list.

ISO 8601 format.

When you set the periodStartDate and periodEndDate, you will search for vacation documents started/ongoing/ended during that period.

Expand
titleExample
Path
Code Block
GET {jira_baseurl}/rest/vacation-manager/1.0/vacation-document?teamId=1
Response
Code Block
[
    {
        "issueId": 10600,
        "issueKey": "VACMAN-1",
        "reporter": {
            "id": 1,
            "name": "user",
            "displayName": "User",
            "active": true
        },
        "supervisor": {
            "id": 2,
            "name": "supervisor",
            "displayName": "Supervisor",
            "active": true
        },
        "status": "OPEN",
        "selectedPeriod": {
            "periodType": "DAILY",
            "startDateTime": 1540159200000,
            "endDateTime": 1540331999999,
            "startDate": 1540159200000,
            "endDate": 1540331999999,
            "usedDays": 0,
            "usedMinutes": 0
        }
    },
    {
        "issueId": 10502,
        "issueKey": "VACMAN-2",
        "reporter": {
            "id": 1,
            "name": "user",
            "displayName": "User",
            "active": true
        },
        "supervisor": {
            "id": 2,
            "name": "supervisor",
            "displayName": "Supervisor",
            "active": true
        },
        "status": "OPEN",
        "selectedPeriod": {
            "periodType": "HOURLY",
            "startDateTime": 1540371600000,
            "endDateTime": 1540378800000,
            "startDate": 1540371600000,
            "endDate": 1540378800000,
            "usedDays": 0,
            "usedMinutes": 0
        }
    }
]

...