org.everit.atlassian.restclient.jiracloud.v3.api

Class ApplicationPropertiesApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v3.api.ApplicationPropertiesApi

public class ApplicationPropertiesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ApplicationPropertiesApi(org.everit.http.restclient.RestClient restClient)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<List<ApplicationProperty>>	getAdvancedSettings(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get advanced settings Returns the application properties that are accessible on the Advanced Settings page.
io.reactivex.Single<List<ApplicationProperty>>	getApplicationProperty(Optional<String> key, Optional<String> permissionLevel, Optional<String> keyFilter, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get application property Returns all application properties or an application property.
io.reactivex.Single<ApplicationProperty>	setApplicationProperty(String id, SimpleApplicationPropertyBean simpleApplicationPropertyBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Set application property Changes the value of an application property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApplicationPropertiesApi

public ApplicationPropertiesApi(org.everit.http.restclient.RestClient restClient)

Method Detail

getAdvancedSettings

public io.reactivex.Single<List<ApplicationProperty>> getAdvancedSettings(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get advanced settings

Returns the application properties that are accessible on the Advanced Settings page. To navigate to the Advanced Settings page in Jira, choose the Jira icon > Jira settings > System, General Configuration and then click Advanced Settings (in the upper right).

Permissions required: Administer Jira global permission.

Parameters:

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<List<ApplicationProperty>>

getApplicationProperty

public io.reactivex.Single<List<ApplicationProperty>> getApplicationProperty(Optional<String> key,
                                                                             Optional<String> permissionLevel,
                                                                             Optional<String> keyFilter,
                                                                             Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get application property

Returns all application properties or an application property.

If you specify a value for the key parameter, then an application property is returned as an object (not in an array). Otherwise, an array of all editable application properties is returned. See Set application property for descriptions of editable properties.

Permissions required: Administer Jira global permission.

Parameters:

key -

The key of the application property.

(optional)

permissionLevel -

The permission level of all items being returned in the list.

(optional)

keyFilter -

When a key isn't provided, this filters the list of results by the application property key using a regular expression. For example, using jira.lf.* will return all application properties with keys that start with jira.lf..

(optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<List<ApplicationProperty>>

setApplicationProperty

public io.reactivex.Single<ApplicationProperty> setApplicationProperty(String id,
                                                                       SimpleApplicationPropertyBean simpleApplicationPropertyBean,
                                                                       Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Set application property

Changes the value of an application property. For example, you can change the value of the jira.clone.prefix from its default value of CLONE - to Clone - if you prefer sentence case capitalization. Editable properties are described below along with their default values.

Advanced settings

The advanced settings below are also accessible in Jira.

Key	Description	Default value
jira.clone.prefix	A string of text that automatically precedes the title of a cloned issue.	CLONE -
jira.date.picker.java.format	The date format for the Java (server-side) generated dates. This must be the same as the jira.date.picker.javascript.format format setting.	d/MMM/yy
jira.date.picker.javascript.format	This date format is for the JavaScript (client-side) generated dates. This must be the same as the jira.date.picker.java.format format setting.	%e/%b/%y
jira.date.time.picker.java.format	The date format for the Java (server-side) generated date times. This must be the same as the jira.date.time.picker.javascript.format format setting.	dd/MMM/yy h:mm a
jira.date.time.picker.javascript.format	This date format is for the JavaScript (client-side) generated date times. This must be the same as the jira.date.time.picker.java.format format setting.	%e/%b/%y %I:%M %p
jira.issue.actions.order	The default order of actions (such as Comments or Change history) displayed on the issue view.	asc
jira.table.cols.subtasks	The columns to show while viewing subtask issues in a table. For example, a list of subtasks on an issue.	issuetype, status, assignee, progress
jira.view.issue.links.sort.order	The sort order of the list of issue links on the issue view.	type, status, priority
jira.comment.collapsing.minimum.hidden	The minimum number of comments required for comment collapsing to occur. A value of 0 disables comment collapsing.	4
jira.newsletter.tip.delay.days	The number of days before a prompt to sign up to the Jira Insiders newsletter is shown. A value of -1 disables this functionality.	7

Look and feel

The settings listed below adjust the look and feel.

Key	Description	Default value
jira.lf.date.time	Look and feel of the time format.	h:mm a
jira.lf.date.day	Look and feel of the day format.	EEEE h:mm a
jira.lf.date.complete	Look and feel of the date and time format.	dd/MMM/yy h:mm a
jira.lf.date.dmy	Look and feel of the date format.	dd/MMM/yy
jira.date.time.picker.use.iso8061	When enabled, sets Monday as the first day of the week in the date picker, as specified by the ISO8601 standard.	false
jira.lf.logo.url	The URL of the logo image file.	/images/icon-jira-logo.png
jira.lf.logo.show.application.title	Controls the visibility of the application title on the sidebar.	false
jira.lf.favicon.url	The URL of the favicon.	/favicon.ico
jira.lf.favicon.hires.url	The URL of the high resolution favicon.	/images/64jira.png
jira.lf.top.adg3.bgcolour	The background color of the sidebar.	#0747A6
jira.lf.top.adg3.textcolour	The color of the text and logo of the sidebar.	#DEEBFF
jira.lf.hero.button.base.bg.colour		#3b7fc4
jira.title	The text for the application title. The application title can also be set in General settings.	Jira
jira.option.globalsharing	boolean	true
xflow.product.suggestions.enabled	Indicates whether to expose product suggestions for other Atlassian products within Jira.	true

Other settings

Key	Description	Default value
jira.issuenav.criteria.autoupdate	Supports instant updates to search criteria.	true

Note: Be careful when changing application properties and advanced settings.

Permissions required: Administer Jira global permission.

Parameters:

id -

The key of the application property to update.

(required)

simpleApplicationPropertyBean - (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<ApplicationProperty>