Versions Compared

Old Version 1

changes.mady.by.user Hua Soon SIM [Akeles]

Saved on

compared with

New Version 2

changes.mady.by.user Hua Soon SIM [Akeles]

Saved on

Key

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

Introduction

It is possible for 3rd party apps to send out of office information or query out of office period with the newly added REST endpoints.

There are 4 REST Resources which can be accessed.

  • ConfigResource - Used for configuring options and JQL Filter. 

  • OutOfOfficeOneTimeRuleResource - Used for configuring any one time rule.

  • OutOfOfficePeriodResource - Used for configuring OutOfOffice Period.

  • OutOfOfficeRecurRuleResource - Used for configuring OutOfOffice Recurring Rule. 

Resources

Configuration Settings

It is possible to update the OOO user options for the users via REST API

Screenshot 2024-05-31 at 12.32.37 PM.png

List of parameters

Data Type

Attribute Name

Default Value

Remarks

String

ignoreSelfAssign

false

true/false to ignore self assignment of issue

String

allowCovererAssignBack

false

true/false to allow coverer to assign issue back

String

oooReplyWhenMentioned

false

true/false to thread reply when being mentioned

String

exclusionMode

default

Exclusion mode for JQL which can be either default or user

String

defaultJql

Default JQL used in the global level

String

userJql

User defined JQL

Expand
titleRetrieve the OOO advance settings of user (GET)

Method

Status
colourBlue
titleGET

URL

/rest/ooo/1.0/

Parameters

N/A

Response

STATUS 200 (tick)

  • Returns the Config Object for Rendering

    Code Block
    languagejson
    {
  "ignoreSelfAssign": "false",
  "allowCovererAssignBack": "false",
  "oooReplyWhenMentioned": "false",
  "exclusionMode": "none",
  "defaultJql": "",
  "userJql": "",
  "highlightOooUser": true
}

STATUS 401  (error)

  • UNAUTHORIZED - Not logged in

    Code Block
    languagexml
    <status>
   <status-code>401</status-code>
   <message>Client must be authenticated to access this resource.</message>
</status>

Remarks

Expand
titleCreate JQL Exclusion Filter for OOO (POST)

Method

Status
colourGreen
titlePOST

URL

/rest/ooo/1.0/

Parameters

To exclude issues from all the projects in testing category

Code Block
languagejson
{ 
    "ignoreSelfAssign": false, 
    "allowCovererAssignBack": false, 
    "oooReplyWhenMentioned": false, 
    "exclusionMode": "user", 
    "userJql": "category%20testing"
}

If exclusion Mode is "default", "defaultJql" will be required instead of "userJql".

Code Block
{
    "exclusionMode": "default",
    "defaultJql": "project = ExampleProject"
}

Attributes not specified are set to their default values in the attributes table above

Response

STATUS 204 (tick)

  • successful creation of JQL Exclusion Filter.  

STATUS 401  (error)

  • UNAUTHORIZED - Not logged in

    Code Block
    languagexml
    <status>
   <status-code>401</status-code>
   <message>Client must be authenticated to access this resource.</message>
</status>

STATUS 406 (error)

  • NOT_ACCEPTABLE - error in JQL

Remarks

Expand
titleUpdate the OOO advance settings for the user (PUT)

Method

Status
colourYellow
titlePUT

URL

/rest/ooo/1.0/

Parameters

Example

Code Block
languagejson
{ 
   "ignoreSelfAssign" : false, 
   "allowCovererAssignBack" : false, 
   "oooReplyWhenMentioned" : false,
   "exclusionMode": "none"
}

Attributes not specified are set to their default values in the attributes table above

Response

STATUS 204 (tick)

  • successful creation of JQL Exclusion Filter.  

STATUS 401  (error)

  • UNAUTHORIZED - Not logged in

    Code Block
    languagexml
    <status>
   <status-code>401</status-code>
   <message>Client must be authenticated to access this resource.</message>
</status>

STATUS 406 (error)

  • NOT_ACCEPTABLE - error in JQL

Remarks

References