Document toolboxDocument toolbox

REST API - User Setting

Introduction

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 Attributes

Data Type

Attribute Name

Default Value

Remarks

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

REST APIs

Method

GET

URL

/rest/ooo/1.0/

Parameters

N/A

Response

STATUS 200

  • Returns the Config Object for Rendering

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

STATUS 401  

  • UNAUTHORIZED - Not logged in

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

Remarks

 

 

 

Method

POST

URL

/rest/ooo/1.0/

Parameters

To exclude issues from all the projects in testing category

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

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

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

Response

STATUS 204

  • successful creation of JQL Exclusion Filter.  

STATUS 401  

  • UNAUTHORIZED - Not logged in

STATUS 406 

  • NOT_ACCEPTABLE - error in JQL

Remarks

 

 

 

Method

PUT

URL

/rest/ooo/1.0/

Parameters

Example

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

Response

STATUS 204

  • successful creation of JQL Exclusion Filter.  

STATUS 401  

  • UNAUTHORIZED - Not logged in

STATUS 406 

  • NOT_ACCEPTABLE - error in JQL

Remarks

 

 

 

References