Page Comparison

Panel

Anchor

	1
	1

Panel

titleColor	#FFFFFF
titleBGColor	#6c809a
title	GET /com.easesolutions.jira.plugins.absent/1.0/absent/outofoffices

Retrieve absences. Either all, for users of a project or a specific user

PARAMETERS

Section

Column

width	30%

page*

projectKey

userKey

filter

Column

width	70%

The page of absences you want to retrieve. They are provided in chunks of 25.

The project key of a projec to only retrieve absences for this project's users

A user key of a user to only retrieve absences for this user

A string of a JSON object representing the filter. See below for more information

FILTER OBJECT

Code Block

language	js

{
	"userKey": '',
    "startDate": 'YYYY-MM-DD',
    "endDate": 'YYYY-MM-DD',
	"substituteKey": ''
}

EXAMPLE RESPONSE

Status Code	Response
200	The JSON body, see belows example response
400	An error occured. You either gave an invalid project/user or don't have the neccesary permissions to view those absences. See the reponse body for additonial information

Code Block

language	js
collapse	true

{
	"results": [
		{
			"id": 182,
			"userKey": "admin",
			"user": {
				"key": "admin",
				"url": "http://localhost:2990/jira/secure/ViewProfile.jspa?name=admin",
				"icon": "",
				"username": "admin",
				"displayname": "admin (abwesend bis 11/Okt/19)"
			},
			"startDate": 1570572000000,
			"startDateFormatted": "09/Oct/19",
			"endDate": 1570831199999,
			"endDateFormatted": "11/Oct/19",
			"comment": ""
		},
		{
			"id": 177,
			"userKey": "user1",
			"user": {
				"key": "user1",
				"url": "http://localhost:2990/jira/secure/ViewProfile.jspa?name=user1",
				"icon": "",
				"username": "user1",
				"displayname": "Max Mustermann"
			},
			"startDate": 1577055600000,
			"startDateFormatted": "23/Dez/19",
			"endDate": 1578005999999,
			"endDateFormatted": "02/Jan/20",
			"comment": "Test 1234",
			"substituteKey": "user2",
			"substitute": {
				"key": "user2",
				"url": "http://zink-ws:2990/jira/secure/ViewProfile.jspa?name=user2",
				"icon": "",
				"username": "user2",
				"displayname": "Frau B."
			}
		}
	],
	"currentPage": 1,
	"totalPages": 1
}

...

Panel

titleColor	#FFFFFF
titleBGColor	#6c809a
title	GET /com.easesolutions.jira.plugins.absent/1.0/absent/outofoffice/{id}

Retrieve an absence by its id

PARAMETERS

Section

Column

width	30%

id*

projectKey

Column

width	70%

The id of the absence you want to retrieve

The project key of a project for permission checks

EXAMPLE RESPONSE

Status Code	Response
200	The JSON body, see belows example response
400	An error occured. You either gave an invalid project or don't have the neccesary permissions to view those absences. See the reponse body for additonial information

Code Block

language	java
collapse	true

{
	"id": 182,
	"userKey": "admin",
	"user": {
		"key": "admin",
		"url": "http://localhost:2990/jira/secure/ViewProfile.jspa?name=admin",
		"icon": "",
		"username": "admin",
		"displayname": "admin (abwesend bis 11/Okt/19)"
	},
	"startDate": 1570572000000,
	"startDateFormatted": "09/Oct/19",
	"endDate": 1570831199999,
	"endDateFormatted": "11/Oct/19",
	"comment": ""
}

Panel

titleColor	#FFFFFF
titleBGColor	#6c809a
title	POST /com.easesolutions.jira.plugins.absent/1.0/absent/outofoffice

Create or update an absence

PARAMETERS

Section

Column

width	30%

page*

projectKey

userKey

filter

Column

width	70%

The page of absences you want to retrieve. They are provided in chunks of 25.

The project key of a projec to only retrieve absences for this project's users

A user key of a user to only retrieve absences for this user

A string of a JSON object representing the filter. See below for more information

FILTER OBJECT

Code Block

language	js

{
	"userKey": '',
    "startDate": 'YYYY-MM-DD',
    "endDate": 'YYYY-MM-DD',
	"substituteKey": ''
}

EXAMPLE RESPONSE

Code Block

language	js
collapse	true

{
	"results": [
		{
			"id": 182,
			"userKey": "admin",
			"user": {
				"key": "admin",
				"url": "http://localhost:2990/jira/secure/ViewProfile.jspa?name=admin",
				"icon": "",
				"username": "admin",
				"displayname": "admin (abwesend bis 11/Okt/19)"
			},
			"startDate": 1570572000000,
			"startDateFormatted": "09/Oct/19",
			"endDate": 1570831199999,
			"endDateFormatted": "11/Oct/19",
			"comment": ""
		},
		{
			"id": 177,
			"userKey": "user1",
			"user": {
				"key": "user1",
				"url": "http://localhost:2990/jira/secure/ViewProfile.jspa?name=user1",
				"icon": "",
				"username": "user1",
				"displayname": "Max Mustermann"
			},
			"startDate": 1577055600000,
			"startDateFormatted": "23/Dez/19",
			"endDate": 1578005999999,
			"endDateFormatted": "02/Jan/20",
			"comment": "Test 1234",
			"substituteKey": "user2",
			"substitute": {
				"key": "user2",
				"url": "http://zink-ws:2990/jira/secure/ViewProfile.jspa?name=user2",
				"icon": "",
				"username": "user2",
				"displayname": "Frau B."
			}
		}
	],
	"currentPage": 1,
	"totalPages": 1
}

Versions Compared

Old Version 16

New Version 17

Key