Versions Compared

Key

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

...

Responses:

Status
colourGreen
title200
 
Status
colourYellow
title400
 
Status
colourRed
title500

Expand
titleExample
Path
title
Code Block
Path
GET {jira_baseurl}/rest/vacation-manager/1.0/workweek-scheme
Response 
Response 
Code Block
title
[
  {
    "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"
  }
]

...

Name

Type

Description

schemeId

int

Scheme ID

Expand
titleExample
Path
title
Code Block
Path
GET {jira_baseurl}/rest/vacation-manager/1.0/workweek-scheme/1
Response 
Code Block
titleResponse 
{
  "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"
}

...

Name

Type

Description

userName

String

User Name

Expand
titleExample
Path
Code Block
titlePath
PATH{jira_baseurl}/rest/vacation-manager/1.0/workweek-scheme?userName=user1
Response
Code Block
titleResponse
{
  "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"
}

...

Permissions:

Status
colourGreen
titleADMIN
 
Status
colourRed
titleUSER
 
Status
colourRed
titleSUPERVISOR
 
Status
colourGreen
titleHR

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

...

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

Expand
titleExample
Path
Path
Code Block
title
POST {jira_baseurl}/rest/vacation-manager/1.0/workweek-scheme
Body
Body
Code Block
title
{
  "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
Code Block
titleResponse
{
  "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"
}

...

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

Expand
titleExample
Path
Path
Code Block
title
PATCH {jira_baseurl}/rest/vacation-manager/1.0/workweek-scheme/2
Body
Code Block
titleBody
 {
  "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
title
Code Block
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"
}

...

Name

Type

Description

schemeId

Code Block
Integer

Id of workweek scheme you want to assign to users 

userNames

Code Block
Array<String>

Names of users you want to assign workweek scheme to

Expand
titleExample
Path
Code Block
titlePath
PUT {jira_baseurl}/rest/vacation-manager/1.0/vacman-user/workweek/bulk
Body
title
Code Block
Body
{
   "schemeId": 1,
   "userNames": ["john", "jack"]
}
Response
Response
Code Block
title
{  
	"userNames": [
		"john", 
		"jack"
	],
   "schemeId": 1
}

...

Name

Type

Description

schemeId

int

Scheme ID

Expand
titleExample
Path
Path
Code Block
title
DELETE {jira_baseurl}/rest/vacation-manager/1.0/workweek-scheme/1